diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/rst/directives.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/ref/rst/directives.txt b/docs/ref/rst/directives.txt index 7f41d1dd2..6c413c4ee 100644 --- a/docs/ref/rst/directives.txt +++ b/docs/ref/rst/directives.txt @@ -961,11 +961,15 @@ Automatic Section Numbering :Directive Options: Possible. :Directive Content: None. -The "sectnum" (or "section-autonumbering") directive automatically -numbers sections and subsections in a document. Section numbers are -of the "multiple enumeration" form, where each level has a number, -separated by periods. For example, the title of section 1, subsection -2, subsubsection 3 would have "1.2.3" prefixed. +The "sectnum" (or "section-autonumbering") directive configures the +automatic numbering of sections and subsections in a document. + +Automatic numbering of sections is turned on or off by the `sectnum_xform`_ +configuration setting or the ``--section-numbering``, +``--no-section-numbering`` command line options. The default is to number +sections. Section numbers are of the "multiple enumeration" form, where each +level has a number, separated by periods. For example, the title of section +1, subsection 2, subsubsection 3 would have "1.2.3" prefixed. The "sectnum" directive does its work in two passes: the initial parse and a transform. During the initial parse, a "pending" element is @@ -998,6 +1002,7 @@ The following options are recognized: numbering for a document split over several source files. The default is 1. +.. _sectnum_xform: ../../user/config.html#sectnum-xform .. _header: .. _footer: |