diff options
| author | Brad King <brad.king@kitware.com> | 2017-02-23 19:05:38 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-03-01 21:05:55 (GMT) |
| commit | d33de80c8a9e3e5e56012cbfe640004f7cb1550f (patch) | |
| tree | 5936e86b758caf8a41b049626c272f23710ac532 | |
| parent | ebc28c156ee56c878990c53cbd62779249b139bb (diff) | |
| download | CMake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.zip CMake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.tar.gz CMake-d33de80c8a9e3e5e56012cbfe640004f7cb1550f.tar.bz2 | |
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.
| -rw-r--r-- | CMakeLists.txt | 1 | ||||
| -rw-r--r-- | Help/dev/README.rst | 15 | ||||
| -rw-r--r-- | Utilities/Sphinx/conf.py.in | 4 |
3 files changed, 19 insertions, 1 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 472c6ab..ed5de10 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -806,6 +806,7 @@ if(NOT CMake_TEST_EXTERNAL_CMAKE) PATTERN "*.sh*" PERMISSIONS OWNER_READ OWNER_EXECUTE OWNER_WRITE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE + REGEX "Help/dev($|/)" EXCLUDE ) # Install auxiliary files integrating with other tools. diff --git a/Help/dev/README.rst b/Help/dev/README.rst new file mode 100644 index 0000000..a7cafcc --- /dev/null +++ b/Help/dev/README.rst @@ -0,0 +1,15 @@ +CMake Development +***************** + +This directory contains documentation about development of CMake itself. +It is not part of the user documentation distributed with CMake. + +Contributor Instructions +======================== + +See `CONTRIBUTING.rst`_ for instructions to contribute changes. + +The process for contributing changes is the same whether or not one +has been invited to participate directly in upstream development. + +.. _`CONTRIBUTING.rst`: ../../CONTRIBUTING.rst diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in index 9581458..e3afc78 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'] |