ソースを参照

README: Explain how to build CMake with the docs

Joachim Wuttke (o) 7 年 前
コミット
af6f16f1e8
1 ファイル変更7 行追加0 行削除
  1. 7 0
      README.rst

+ 7 - 0
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
 ==============