diff options
author | Brad King <brad.king@kitware.com> | 2013-09-17 20:08:05 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:37 (GMT) |
commit | bfe07aa97efdd0c9a5fb9eb7adc0a1a166149711 (patch) | |
tree | fe8d3fce64d6708f032411f497e7b3c3e99857ac /Source/cmVisualStudioWCEPlatformParser.cxx | |
parent | 53ded5951537cd776ed5d1db7b2002bb580583be (diff) | |
download | CMake-bfe07aa97efdd0c9a5fb9eb7adc0a1a166149711.zip CMake-bfe07aa97efdd0c9a5fb9eb7adc0a1a166149711.tar.gz CMake-bfe07aa97efdd0c9a5fb9eb7adc0a1a166149711.tar.bz2 |
Build Help documentation during CMake build using Sphinx
Add a Utilities/Sphinx directory to hold CMake build code to run the
Sphinx (sphinx-doc.org) documentation generation tool. Create a
CMakeLists.txt file there capable of building either as a subdirectory
of the main CMake build, or as a standalone documentation build.
Add cache options SPHINX_MAN and SPHINX_HTML to select output formats
and SPHINX_EXECUTABLE to specify the sphinx-build executable. Add
bootstrap options --sphix-man and --sphinx-html to select output formats
and --sphinx-build=<sb> to specify the sphinx-build executable.
Create a "conf.py.in" file to configure_file into "conf.py" to tell
sphinx-build how to build our documents. Create a "cmake.py" Sphinx
extension module defining:
* The "cmake-module" directive used in Help/module/*.rst files to
scan .rst markup from the corresponding Modules/*.cmake file.
* A Sphinx domain called "cmake" defining documentation object types
for CMake Help/<type> directories: command, generator, manual,
module, policy, prop_*, and variable. Add a "role" for each type
to perform cross-references. Teach the roles to treat "<XYZ>"
as placeholders instead of explicit targets if not preceded by
a space. Add cmake domain directives to define command and
variable objects explicitly in .rst file content. This will
allow modules to define their own commands and variables and
have them indexed and linkable.
* A Sphinx document transform that converts Help/<type>/*.rst documents
into cmake domain objects of the corresponding <type> and adds index
entries for them. This will automatically index all CMake documentation
objects and provide cross-reference targets for them with no special
markup in the .rst files.
Diffstat (limited to 'Source/cmVisualStudioWCEPlatformParser.cxx')
0 files changed, 0 insertions, 0 deletions