hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-26 09:15:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1663 from jf205/vscode-readme

Browse Source 
docs: update readme to mention vscode extension
This commit is contained in:
Felicity Chapman
2019-07-31 13:52:58 +01:00
committed by GitHub
parent 4722ec585d 862f716058
commit 7123067bd0
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/ql-documentation/README.rst
View File

@@ -51,6 +51,9 @@ Building and previewing the QL language documentation
To build and preview the QL documentation locally, you need to install Sphinx.
For installation options, see https://github.com/sphinx-doc/sphinx.
Using ``sphinx-build``
----------------------
After installing Sphinx, you can build the HTML files for a project by running
`sphinx-build <https://www.sphinx-doc.org/en/master/man/sphinx-build.html>`__
from the project's
@@ -62,6 +65,22 @@ For example, to generate the HTML output for a project in the
sphinx-build -b html . <docs-output>
..
Add the ``-W`` flag to turn *warnings* into *errors* during the build process.
You can use errors reported during the build to debug problems in your source
code, such as broken internal links and malformed tables.
Add the ``-a`` flag to regenerate all output files. By default, only files that
have changed are rebuilt.
Using the reStructuredText Extension for Visual Studio Code
-----------------------------------------------------------
Visual Studio Code has an extension that can be used to preview Sphinx-generated
output alongside ``.rst`` source code in your IDE. For more information, see the
`Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext>`__.
Building and previewing the QL training presentations
*****************************************************