kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge topic 'release-notes' 

ccc87047 Help: Add documents to collect notes between releases
70309e70 Help: Add documents for release notes
34ea1f15 Utilities/Sphinx: Add option to build 'text' format
This commit is contained in:
Brad King 2014-02-05 09:34:30 -05:00 committed by CMake Topic Stage
parent c475b42a66 ccc8704777
commit 0bae76b439
5 changed files with 54 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Help/index.rst
View File

@ -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

16
Help/release/dev.txt Normal file
View File

@ -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/*

7
Help/release/dev/0-sample-topic.rst Normal file
View File

@ -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.

14
Help/release/index.rst Normal file
View File

@ -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

8
Utilities/Sphinx/CMakeLists.txt
View File

@ -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 "")