diff --git a/llvm/docs/MarkdownQuickstartTemplate.md b/llvm/docs/MarkdownQuickstartTemplate.md --- a/llvm/docs/MarkdownQuickstartTemplate.md +++ b/llvm/docs/MarkdownQuickstartTemplate.md @@ -155,3 +155,7 @@ [Common Mark spec]: http://spec.commonmark.org/0.28/ [recommonmark docs]: http://recommonmark.readthedocs.io/en/latest/index.html + +## Generating the documentation + +see [Sphinx Quickstart Template](SphinxQuickstartTemplate.html#generating-the-documentation) diff --git a/llvm/docs/SphinxQuickstartTemplate.rst b/llvm/docs/SphinxQuickstartTemplate.rst --- a/llvm/docs/SphinxQuickstartTemplate.rst +++ b/llvm/docs/SphinxQuickstartTemplate.rst @@ -165,3 +165,32 @@ ... +Generating the documentation +============================ + +You can generate the HTML documentation from the sources locally if you want to +see what they would look like. In addition to the normal +`build tools `_ +you need to install `Sphinx`_ and the +`recommonmark `_ extension. + +On Debian you can install these with: + +.. code-block:: console + + sudo apt install -y sphinx-doc python-recommonmark-doc + +Then run cmake to build the documentation inside the ``llvm-project`` checkout: + +.. code-block:: console + + mkdir build + cd build + cmake -DLLVM_ENABLE_SPHINX=On ../llvm + cmake --build . --target docs-llvm-html + +In case you already have the Cmake build set up and want to reuse that, +just set the CMake variable ``LLVM_ENABLE_SPHINX=On``. + +After that you find the generated documentation in ``build/docs/html`` +folder.