mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity

Help/dev: Document use of sphinx-copybutton

Browse Source 
Add a section on third-party Sphinx extensions. While we're here, add
a cross-reference on CMake's `README.rst`.
This commit is contained in:
Tyler Yankee
2026-08-21 09:43:48 -04:00
parent 1c5e70c9d0
commit 392a79b910
2 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+3 -1
View File
@@ -57,12 +57,14 @@ generator and options. Then build it and install it.
To build the documentation, install `Sphinx`_ and configure CMake with
``-DSPHINX_HTML=ON`` and/or ``-DSPHINX_MAN=ON`` to enable the "html" or
"man" builder. Add ``-DSPHINX_EXECUTABLE=/path/to/sphinx-build`` if the
tool is not found automatically.
tool is not found automatically. See the `CMake Documentation Guide`_ for
details.
To run the test suite, run ``ctest`` in the CMake build directory after
building. See the `CMake Testing Guide`_ for details.
.. _`Sphinx`: https://sphinx-doc.org
.. _`CMake Documentation Guide`: Help/dev/documentation.rst
.. _`CMake Testing Guide`: Help/dev/testing.rst
Building CMake from Scratch