@@ -51,6 +51,9 @@ Building and previewing the QL language documentation
5151To build and preview the QL documentation locally, you need to install Sphinx.
5252For installation options, see https://github.com/sphinx-doc/sphinx.
5353
54+ Using ``sphinx-build ``
55+ ----------------------
56+
5457After 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 >`__
5659from 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+
6584Building and previewing the QL training presentations
6685*****************************************************
6786
0 commit comments