[PATCH] D107460: [doc] added section on generating the html doc

[Christian Kühnel via Phabricator via llvm-commits]

This revision was not accepted when it landed; it landed in state "Needs Review".
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rG15acaad79d6e: [doc] added section on generating the html doc (authored by kuhnel).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D107460/new/

https://reviews.llvm.org/D107460

Files:
  llvm/docs/MarkdownQuickstartTemplate.md
  llvm/docs/SphinxQuickstartTemplate.rst


Index: llvm/docs/SphinxQuickstartTemplate.rst
===================================================================
--- llvm/docs/SphinxQuickstartTemplate.rst
+++ 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 <docs/GettingStarted.html>`_
+you need to install `Sphinx`_ and the 
+`recommonmark <https://recommonmark.readthedocs.io/en/latest/>`_ 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.
Index: llvm/docs/MarkdownQuickstartTemplate.md
===================================================================
--- llvm/docs/MarkdownQuickstartTemplate.md
+++ 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)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D107460.365098.patch
Type: text/x-patch
Size: 1677 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210809/0f5e00b2/attachment.bin>