diff options
| author | Orivej Desh <orivej@gmx.fr> | 2018-06-12 01:14:10 +0000 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-06-12 10:25:37 -0400 |
| commit | 276e369813f100562c3e22020635552edfb722a2 (patch) | |
| tree | 8df0588a5b93781d3c714ad20f3a4cc605b65ddb /Utilities/Sphinx | |
| parent | 90ebc32d9e7400a590973b30c99f2986bcb2b755 (diff) | |
| download | cmake-276e369813f100562c3e22020635552edfb722a2.tar.gz | |
Utilities/Sphinx: Add option to build and install Info manual
Add option `SPHINX_INFO` to enable the Sphinx 'texinfo' builder and use
the `makeinfo` tool to convert it to a `.info` file.
Diffstat (limited to 'Utilities/Sphinx')
| -rw-r--r-- | Utilities/Sphinx/CMakeLists.txt | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt index 2de821c2be..1cbc463714 100644 --- a/Utilities/Sphinx/CMakeLists.txt +++ b/Utilities/Sphinx/CMakeLists.txt @@ -17,6 +17,7 @@ if(NOT CMake_SOURCE_DIR) endif() project(CMakeHelp NONE) +option(SPHINX_INFO "Build Info manual with Sphinx" OFF) option(SPHINX_MAN "Build man pages with Sphinx" OFF) option(SPHINX_HTML "Build html help with Sphinx" OFF) option(SPHINX_SINGLEHTML "Build html single page help with Sphinx" OFF) @@ -32,7 +33,7 @@ separate_arguments(sphinx_flags UNIX_COMMAND "${SPHINX_FLAGS}") mark_as_advanced(SPHINX_TEXT) mark_as_advanced(SPHINX_FLAGS) -if(NOT SPHINX_MAN AND NOT SPHINX_HTML AND NOT SPHINX_SINGLEHTML AND NOT SPHINX_QTHELP AND NOT SPHINX_TEXT) +if(NOT SPHINX_INFO AND NOT SPHINX_MAN AND NOT SPHINX_HTML AND NOT SPHINX_SINGLEHTML AND NOT SPHINX_QTHELP AND NOT SPHINX_TEXT) return() elseif(NOT SPHINX_EXECUTABLE) message(FATAL_ERROR "SPHINX_EXECUTABLE (sphinx-build) is not found!") @@ -66,6 +67,24 @@ endif() if(SPHINX_TEXT) list(APPEND doc_formats text) endif() +if(SPHINX_INFO) + find_program(MAKEINFO_EXECUTABLE + NAMES makeinfo + DOC "makeinfo tool" + ) + if (NOT MAKEINFO_EXECUTABLE) + message(FATAL_ERROR "MAKEINFO_EXECUTABLE (makeinfo) not found!") + endif() + list(APPEND doc_formats texinfo) + + # Sphinx texinfo builder supports .info, .txt, .html and .pdf output. + # SPHINX_INFO controls the .info output. + set(texinfo_extra_commands + COMMAND ${MAKEINFO_EXECUTABLE} --no-split -o + ${CMAKE_CURRENT_BINARY_DIR}/texinfo/cmake.info + ${CMAKE_CURRENT_BINARY_DIR}/texinfo/cmake.texi + ) +endif() if(SPHINX_QTHELP) find_package(PythonInterp REQUIRED) @@ -143,6 +162,14 @@ if(CMake_SPHINX_DEPEND_ON_EXECUTABLES) endforeach() endif() +if(SPHINX_INFO) + CMake_OPTIONAL_COMPONENT(sphinx-info) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/texinfo/cmake.info + DESTINATION ${CMAKE_INFO_DIR} + ${COMPONENT} + ) +endif() + if(SPHINX_MAN) file(GLOB man_rst RELATIVE ${CMake_SOURCE_DIR}/Help/manual ${CMake_SOURCE_DIR}/Help/manual/*.[1-9].rst) |