diff options
author | Brad King <brad.king@kitware.com> | 2013-09-12 14:05:46 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-15 14:47:39 (GMT) |
commit | f85405f5515ed5cc20ffe97c485d7dfef6ffc288 (patch) | |
tree | 82ad6c306db15100c3afa4836aefb9ae74e372a7 /Source/cmDocumentation.cxx | |
parent | 0d0fec152443fa3f63af8e68e3b2784b6523d85d (diff) | |
download | CMake-f85405f5515ed5cc20ffe97c485d7dfef6ffc288.zip CMake-f85405f5515ed5cc20ffe97c485d7dfef6ffc288.tar.gz CMake-f85405f5515ed5cc20ffe97c485d7dfef6ffc288.tar.bz2 |
Add reStructuredText (RST) documentation formatter
Temporarily add a RST formatter to convert builtin documentation to .rst
source files. This will be removed shortly after we use it to convert
documentation.
Teach the RST formatter to:
* Output preformatted blocks as reStructuredText "::" literal blocks.
* Output option lists as bullet lists with option names enclosed in
reStructuredText ``literal`` quoting.
* Output individual documentation objects (commands, variables, etc.)
in separate .rst files organized in directories by type.
Replace references to cmVersion::GetCMakeVersion() in builtin
documentation with the literal placeholder "|release|" that will be
defined as a substitution later.
Diffstat (limited to 'Source/cmDocumentation.cxx')
-rw-r--r-- | Source/cmDocumentation.cxx | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index b0643b0..83be32d 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -654,6 +654,11 @@ cmDocumentation::Form cmDocumentation::GetFormFromFilename( return cmDocumentation::ManForm; } + if (ext == ".RST") + { + return cmDocumentation::RSTForm; + } + return cmDocumentation::TextForm; } @@ -1580,6 +1585,9 @@ void cmDocumentation::SetForm(Form f, int manSection) this->ManFormatter.SetManSection(manSection); this->CurrentFormatter = &this->ManFormatter; break; + case RSTForm: + this->CurrentFormatter = &this->RSTFormatter; + break; case TextForm: this->CurrentFormatter = &this->TextFormatter; break; |