From 4665dba9e4e3ee4357280d0ff09c803dc531b2ca Mon Sep 17 00:00:00 2001 From: Peter Kokot Date: Thu, 17 Apr 2025 01:44:43 +0200 Subject: [PATCH] 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. --- Help/dev/documentation.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Help/dev/documentation.rst b/Help/dev/documentation.rst index ada6ab4093..500cf054f2 100644 --- a/Help/dev/documentation.rst +++ b/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 -----------------