diff options
| author | Brad King <brad.king@kitware.com> | 2014-06-02 17:59:35 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-06-02 18:04:00 (GMT) |
| commit | 793b64e49922b3a7bf4b6afa23b4a14308330460 (patch) | |
| tree | 2873d05b56c45cbb0370a131d6ad789f67695d14 /Help/manual/cmake-developer.7.rst | |
| parent | 05bd31ab3ec5e0fc1e15c6504bf2e40b7d1c6a77 (diff) | |
| download | CMake-793b64e49922b3a7bf4b6afa23b4a14308330460.zip CMake-793b64e49922b3a7bf4b6afa23b4a14308330460.tar.gz CMake-793b64e49922b3a7bf4b6afa23b4a14308330460.tar.bz2 | |
Help: Document section header underline hierarchy in cmake-developer.7
Explicitly specify the sequence of underline characters we use in the
CMake documentation. It is the same sequence as that suggested in the
Sphinx documentation, but we have our own descriptions.
Diffstat (limited to 'Help/manual/cmake-developer.7.rst')
| -rw-r--r-- | Help/manual/cmake-developer.7.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 9476d64..9851c12 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -479,6 +479,15 @@ example: Capitalize the first letter of each non-minor word in the title. +The section header underline character hierarchy is + +* ``#``: Manual group (part) in the master document +* ``*``: Manual (chapter) title +* ``=``: Section within a manual +* ``-``: Subsection or `CMake Domain`_ object document title +* ``^``: Subsubsection or `CMake Domain`_ object document section +* ``"``: Paragraph or `CMake Domain`_ object document subsection + Style: Whitespace ^^^^^^^^^^^^^^^^^ |