kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Brad King 2014-06-02 13:59:35 -04:00
parent 05bd31ab3e
commit 793b64e499
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Help/manual/cmake-developer.7.rst
View File

@ -479,6 +479,15 @@ example:
Capitalize the first letter of each non-minor word in the title. 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 Style: Whitespace
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^