diff options
-rw-r--r-- | Help/index.rst | 10 | ||||
-rw-r--r-- | Help/release/dev.txt | 16 | ||||
-rw-r--r-- | Help/release/dev/0-sample-topic.rst | 7 | ||||
-rw-r--r-- | Help/release/index.rst | 14 | ||||
-rw-r--r-- | Utilities/Sphinx/CMakeLists.txt | 8 |
5 files changed, 54 insertions, 1 deletions
diff --git a/Help/index.rst b/Help/index.rst index 7fce223..a4abfbf 100644 --- a/Help/index.rst +++ b/Help/index.rst @@ -39,6 +39,16 @@ Reference Manuals /manual/cmake-toolchains.7 /manual/cmake-variables.7 +.. only:: html or text + + Release Notes + ############# + + .. toctree:: + :maxdepth: 1 + + /release/index + .. only:: html Index and Search diff --git a/Help/release/dev.txt b/Help/release/dev.txt new file mode 100644 index 0000000..2cf9193 --- /dev/null +++ b/Help/release/dev.txt @@ -0,0 +1,16 @@ +.. + This file should be included by the adjacent "index.rst" + in development versions but not in release versions. + +Changes Since Release +===================== + +The following noteworthy changes have been made in this development +version since the preceding release but have not yet been consolidated +into notes for a specific release version: + +.. toctree:: + :maxdepth: 1 + :glob: + + dev/* diff --git a/Help/release/dev/0-sample-topic.rst b/Help/release/dev/0-sample-topic.rst new file mode 100644 index 0000000..e4cc01e --- /dev/null +++ b/Help/release/dev/0-sample-topic.rst @@ -0,0 +1,7 @@ +0-sample-topic +-------------- + +* This is a sample release note for the change in a topic. + Developers should add similar notes for each topic branch + making a noteworthy change. Each document should be named + and titled to match the topic name to avoid merge conflicts. diff --git a/Help/release/index.rst b/Help/release/index.rst new file mode 100644 index 0000000..f8367d7 --- /dev/null +++ b/Help/release/index.rst @@ -0,0 +1,14 @@ +CMake Release Notes +******************* + +.. + This file should include the adjacent "dev.txt" file + in development versions but not in release versions. + +.. include:: dev.txt + +Releases +======== + +.. toctree:: + :maxdepth: 1 diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt index c60788f..23dc6ae 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 "") |