diff options
| author | Brad King <brad.king@kitware.com> | 2018-10-09 16:02:17 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2018-10-09 16:02:23 (GMT) |
| commit | b57560bb0fcb30cefe681c79a75ff29c43ee3931 (patch) | |
| tree | b303c7b4b22bdf73b915fdb0e9b9c7b4ccddfc0c | |
| parent | 517cc8e1ef8b3471dac452f494cf56889b92d1a0 (diff) | |
| parent | af6f16f1e8a820ff5a08dfa273ceaa309fed7461 (diff) | |
| download | CMake-b57560bb0fcb30cefe681c79a75ff29c43ee3931.zip CMake-b57560bb0fcb30cefe681c79a75ff29c43ee3931.tar.gz CMake-b57560bb0fcb30cefe681c79a75ff29c43ee3931.tar.bz2 | |
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
| -rw-r--r-- | README.rst | 9 |
1 files changed, 8 insertions, 1 deletions
@@ -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 ============== |