summaryrefslogtreecommitdiff
path: root/Utilities/Sphinx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-02-23 14:05:38 -0500
committerBrad King <brad.king@kitware.com>2017-03-01 16:05:55 -0500
commitd33de80c8a9e3e5e56012cbfe640004f7cb1550f (patch)
tree5936e86b758caf8a41b049626c272f23710ac532 /Utilities/Sphinx
parentebc28c156ee56c878990c53cbd62779249b139bb (diff)
downloadcmake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.tar.gz
Help/dev: Exclude this directory from user-facing documentation
Teach Sphinx and our own install rules to skip a `Help/dev` directory. This will give us a place to put developer-only documentation that should not be included in the user-facing documentation. Add a placeholder README.
Diffstat (limited to 'Utilities/Sphinx')
-rw-r--r--Utilities/Sphinx/conf.py.in4
1 files changed, 3 insertions, 1 deletions
diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in
index 9581458631..e3afc78ccd 100644
--- a/Utilities/Sphinx/conf.py.in
+++ b/Utilities/Sphinx/conf.py.in
@@ -18,7 +18,9 @@ release = '@conf_release@' # full version string
primary_domain = 'cmake'
-exclude_patterns = []
+exclude_patterns = [
+ 'dev', # ignore developer-only documentation
+ ]
extensions = ['cmake']
templates_path = ['@conf_path@/templates']