summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-12 14:05:46 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 14:47:39 (GMT)
commitf85405f5515ed5cc20ffe97c485d7dfef6ffc288 (patch)
tree82ad6c306db15100c3afa4836aefb9ae74e372a7 /Source/cmDocumentation.h
parent0d0fec152443fa3f63af8e68e3b2784b6523d85d (diff)
downloadCMake-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.h')
-rw-r--r--Source/cmDocumentation.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index 68ddbb8..151c242 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -18,6 +18,7 @@
#include "cmDocumentationFormatterHTML.h"
#include "cmDocumentationFormatterDocbook.h"
#include "cmDocumentationFormatterMan.h"
+#include "cmDocumentationFormatterRST.h"
#include "cmDocumentationFormatterText.h"
#include "cmDocumentationFormatterUsage.h"
#include "cmDocumentationSection.h"
@@ -222,6 +223,7 @@ private:
cmDocumentationFormatterHTML HTMLFormatter;
cmDocumentationFormatterDocbook DocbookFormatter;
cmDocumentationFormatterMan ManFormatter;
+ cmDocumentationFormatterRST RSTFormatter;
cmDocumentationFormatterText TextFormatter;
cmDocumentationFormatterUsage UsageFormatter;