1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00

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.
This commit is contained in:
Peter Kokot
2025-04-17 01:44:43 +02:00
parent ca9fa874d8
commit 4665dba9e4

View File

@@ -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
-----------------