summaryrefslogtreecommitdiff
path: root/Utilities/Sphinx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-02-04 10:09:40 -0500
committerBrad King <brad.king@kitware.com>2014-02-04 10:29:05 -0500
commit34ea1f1520a290fbe19d0f9fbe413f50157120a9 (patch)
tree3ce553e567a95e1ab76d17d161d35d0f38d94efb /Utilities/Sphinx
parent3611d77b6dbff46d45f9f5855218e6028044e850 (diff)
downloadcmake-34ea1f1520a290fbe19d0f9fbe413f50157120a9.tar.gz
Utilities/Sphinx: Add option to build 'text' format
Add SPHINX_TEXT to enable the Sphinx 'text' builder. Mark it as advanced and do not add install rules. This is intended for use by the release manager to build the release notes in text format suitable for email.
Diffstat (limited to 'Utilities/Sphinx')
-rw-r--r--Utilities/Sphinx/CMakeLists.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt
index c60788faf2..23dc6ae1e4 100644
--- a/Utilities/Sphinx/CMakeLists.txt
+++ b/Utilities/Sphinx/CMakeLists.txt
@@ -24,12 +24,15 @@ project(CMakeHelp NONE)
option(SPHINX_MAN "Build man pages with Sphinx" OFF)
option(SPHINX_HTML "Build html help with Sphinx" OFF)
+option(SPHINX_TEXT "Build text help with Sphinx (not installed)" OFF)
find_program(SPHINX_EXECUTABLE
NAMES sphinx-build
DOC "Sphinx Documentation Builder (sphinx-doc.org)"
)
-if(NOT SPHINX_MAN AND NOT SPHINX_HTML)
+mark_as_advanced(SPHINX_TEXT)
+
+if(NOT SPHINX_MAN AND NOT SPHINX_HTML AND NOT SPHINX_TEXT)
return()
elseif(NOT SPHINX_EXECUTABLE)
message(FATAL_ERROR "SPHINX_EXECUTABLE (sphinx-build) is not found!")
@@ -57,6 +60,9 @@ endif()
if(SPHINX_MAN)
list(APPEND doc_formats man)
endif()
+if(SPHINX_TEXT)
+ list(APPEND doc_formats text)
+endif()
set(doc_format_outputs "")
set(doc_format_last "")