diff options
| author | Brad King <brad.king@kitware.com> | 2019-05-30 16:25:39 (GMT) |
|---|---|---|
| committer | Betsy McPhail <betsy.mcphail@kitware.com> | 2019-06-18 14:36:16 (GMT) |
| commit | d2fde9480955cf2246519357e01ab5142a067efc (patch) | |
| tree | 84131f83ba9f855099d3520c2792cdf607669456 | |
| parent | f067af8e385d17cc5b14e43475ded4d9d38317a2 (diff) | |
| download | CMake-d2fde9480955cf2246519357e01ab5142a067efc.zip CMake-d2fde9480955cf2246519357e01ab5142a067efc.tar.gz CMake-d2fde9480955cf2246519357e01ab5142a067efc.tar.bz2 | |
Help: Add infrastructure for guide-level documentation
Create a `Help/guide/` directory to hold guide-level documents.
Build them in most documentation formats, but not as man pages.
Initialize the guide directory with a placeholder for the tutorial.
| -rw-r--r-- | CMakeLists.txt | 2 | ||||
| -rw-r--r-- | Help/guide/tutorial/index.rst | 2 | ||||
| -rw-r--r-- | Help/index.rst | 8 |
3 files changed, 11 insertions, 1 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 51a1d8b..399e79c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -817,7 +817,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 + REGEX "Help/(dev|guide|index.rst)($|/)" EXCLUDE ) # Install auxiliary files integrating with other tools. diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst new file mode 100644 index 0000000..be906af --- /dev/null +++ b/Help/guide/tutorial/index.rst @@ -0,0 +1,2 @@ +CMake Tutorial +************** diff --git a/Help/index.rst b/Help/index.rst index a948939..cf1d2f1 100644 --- a/Help/index.rst +++ b/Help/index.rst @@ -44,6 +44,14 @@ Reference Manuals /manual/cmake-variables.7 /manual/cpack-generators.7 +Guides +###### + +.. toctree:: + :maxdepth: 1 + + /guide/tutorial/index + .. only:: html or text Release Notes |