From 793b64e49922b3a7bf4b6afa23b4a14308330460 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Jun 2014 13:59:35 -0400 Subject: 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. --- Help/manual/cmake-developer.7.rst | 9 +++++++++ 1 file changed, 9 insertions(+) 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 ^^^^^^^^^^^^^^^^^ -- cgit v0.12