Sectnum Directives

.. sectnum:: (docutils' other spelling: .. section-numbering::) numbers every section in the document it's written in, wherever it's written — unlike .. contents::, its effect is document-wide rather than scoped to where the directive sits, so unlike Contents Directives each option combination below gets its own page instead of a single page with several :local: examples.

• Default Numbering
  • 1. Installing
    • 1.1. From Source
  • 2. Configuring
• Depth Limit
  • 1. Installing
    • From Source
  • 2. Configuring
• Start Value
  • 5. Installing
  • 6. Configuring
• Prefix and Suffix
  • 1. Installing
  • 2. Configuring

Default numbering

"Default" numbers every section and subsection with no options at all.

Depth limit

"Depth" stops one level short with :depth: 1.

Start value

"Start" begins its first chapter at :start: 5 instead of 1.

Prefix and suffix

"Prefix and Suffix" wraps every number in literal text with :prefix: and :suffix:.

Precedence with :numbered:

A document reached by a :numbered: toctree that also writes its own .. sectnum:: ignores the directive entirely — the toctree's numbering wins, exactly like a nested :numbered: toctree is ignored inside an already-numbered subtree. See Toctree Directives's own "Numbering" section for that page.