diff options
| author | Dan Liew <dan@su-root.co.uk> | 2014-04-29 16:13:27 +0000 |
|---|---|---|
| committer | Dan Liew <dan@su-root.co.uk> | 2014-04-29 16:13:27 +0000 |
| commit | f90262a09d35f9aba24357196f961733a4291aba (patch) | |
| tree | e26d719c40b5ed4b3b04f5ecce1a8c4f407d394a /docs/CMake.rst | |
| parent | 9c770981251c6795e7361857b3706c889a9b6276 (diff) | |
| download | llvm-f90262a09d35f9aba24357196f961733a4291aba.tar.gz llvm-f90262a09d35f9aba24357196f961733a4291aba.tar.bz2 llvm-f90262a09d35f9aba24357196f961733a4291aba.tar.xz | |
Document recently added sphinx documentation options in
CMake.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@207543 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CMake.rst')
| -rw-r--r-- | docs/CMake.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/CMake.rst b/docs/CMake.rst index f0f1726879..ce71dab6fc 100644 --- a/docs/CMake.rst +++ b/docs/CMake.rst @@ -283,6 +283,12 @@ LLVM-specific variables are ``Address``, ``Memory`` and ``MemoryWithOrigins``. Defaults to empty string. +**LLVM_BUILD_DOCS**:BOOL + Enables all enabled documentation targets (i.e. Doxgyen and Sphinx targets) to + be built as part of the normal build. If the ``install`` target is run then + this also enables all built documentation targets to be installed. Defaults to + OFF. + **LLVM_ENABLE_DOXYGEN**:BOOL Enables the generation of browsable HTML documentation using doxygen. Defaults to OFF. @@ -328,6 +334,27 @@ LLVM-specific variables ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no effect. +**LLVM_ENABLE_SPHINX**:BOOL + If enabled CMake will search for the ``sphinx-build`` executable and will make + the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available. + Defaults to OFF. + +**SPHINX_EXECUTABLE**:STRING + The path to the ``sphinx-build`` executable detected by CMake. + +**SPHINX_OUTPUT_HTML**:BOOL + If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) then the targets for + building the documentation as html are added (but not built by default unless + ``LLVM_BUILD_DOCS`` is enabled). There is a target for each project in the + source tree that uses sphinx (e.g. ``docs-llvm-html``, ``docs-clang-html`` + and ``docs-lld-html``). Defaults to ON. + +**SPHINX_OUTPUT_MAN**:BOOL + If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) the targets for building + the man pages are added (but not built by default unless ``LLVM_BUILD_DOCS`` + is enabled). Currently the only target added is ``docs-llvm-man``. Defaults + to ON. + Executing the test suite ======================== |