Browse Source

Help/dev: Add info how to generate documentation locally

This adds a short info to the development documentation how to build it
locally quickly using only Utilities/Sphinx source directory.
Peter Kokot 6 months ago
parent
commit
4665dba9e4
1 changed files with 8 additions and 0 deletions
  1. 8 0
      Help/dev/documentation.rst

+ 8 - 0
Help/dev/documentation.rst

@@ -16,6 +16,14 @@ processed by `Sphinx`_ to generate the CMake help manuals.
 .. _`reStructuredText`: https://docutils.sourceforge.net/docs/ref/rst/introduction.html
 .. _`Sphinx`: https://sphinx-doc.org
 
+To generate the HTML and/or man documentation locally from within the CMake
+repository to ``build/html`` and ``build/man`` directories:
+
+.. code-block:: console
+
+  $ cmake -S Utilities/Sphinx -B build -DSPHINX_HTML=ON -DSPHINX_MAN=ON
+  $ cmake --build build
+
 Markup Constructs
 -----------------