Skip to content

Commit 7123067

Browse files
author
Felicity Chapman
authored
Merge pull request #1663 from jf205/vscode-readme
docs: update readme to mention vscode extension
2 parents 4722ec5 + 862f716 commit 7123067

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/ql-documentation/README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ Building and previewing the QL language documentation
5151
To build and preview the QL documentation locally, you need to install Sphinx.
5252
For installation options, see https://github.com/sphinx-doc/sphinx.
5353

54+
Using ``sphinx-build``
55+
----------------------
56+
5457
After installing Sphinx, you can build the HTML files for a project by running
5558
`sphinx-build <https://www.sphinx-doc.org/en/master/man/sphinx-build.html>`__
5659
from the project's
@@ -62,6 +65,22 @@ For example, to generate the HTML output for a project in the
6265
6366
sphinx-build -b html . <docs-output>
6467
68+
..
69+
70+
Add the ``-W`` flag to turn *warnings* into *errors* during the build process.
71+
You can use errors reported during the build to debug problems in your source
72+
code, such as broken internal links and malformed tables.
73+
74+
Add the ``-a`` flag to regenerate all output files. By default, only files that
75+
have changed are rebuilt.
76+
77+
Using the reStructuredText Extension for Visual Studio Code
78+
-----------------------------------------------------------
79+
80+
Visual Studio Code has an extension that can be used to preview Sphinx-generated
81+
output alongside ``.rst`` source code in your IDE. For more information, see the
82+
`Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext>`__.
83+
6584
Building and previewing the QL training presentations
6685
*****************************************************
6786

0 commit comments

Comments
 (0)