Merge topic 'readme-build-docs'

af6f16f1e8 README: Explain how to build CMake with the docs
ae80271ed3 README: Fix typo (rm space).

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2466
This commit is contained in:
Brad King authored and Kitware Robot committed 2018-10-09 12:02:23 -04:00
commit b57560bb0f
1 file changed
+8 -1
+8 -1
View File
@@ -68,7 +68,7 @@ Windows
^^^^^^^
You need to download and install a binary release of CMake in order to build
CMake. You can get these releases from the `CMake Download Page`_ . Then
CMake. You can get these releases from the `CMake Download Page`_. Then
proceed with the instructions below.
.. _`CMake Download Page`: https://cmake.org/cmake/resources/software.html
@@ -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
==============