summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2018-10-09 11:26:50 (GMT)
committerJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2018-10-09 15:57:32 (GMT)
commitaf6f16f1e8a820ff5a08dfa273ceaa309fed7461 (patch)
treedfd411c8bbf776a2f5170d002385dbdf228f5a04 /README.rst
parentae80271ed35469d4d1092beb9665837963ba22ad (diff)
downloadCMake-af6f16f1e8a820ff5a08dfa273ceaa309fed7461.zip
CMake-af6f16f1e8a820ff5a08dfa273ceaa309fed7461.tar.gz
CMake-af6f16f1e8a820ff5a08dfa273ceaa309fed7461.tar.bz2
README: Explain how to build CMake with the docs
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 2e271ed..1e8561a 100644
--- a/README.rst
+++ b/README.rst
@@ -83,6 +83,13 @@ For instructions how to do this, see documentation on `Running CMake`_.
.. _`Running CMake`: https://cmake.org/cmake/help/runningcmake.html
+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.
+
+.. _`Sphinx`: http://sphinx-doc.org
+
Reporting Bugs
==============