From af6f16f1e8a820ff5a08dfa273ceaa309fed7461 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (o)" Date: Tue, 9 Oct 2018 13:26:50 +0200 Subject: README: Explain how to build CMake with the docs --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) 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 ============== -- cgit v0.12