docutils.transforms.parts.SectNum

class documentation

class SectNum(Transform): (source)

Constructor: SectNum(document, startnode)

View In Hierarchy

Automatically assigns numbers to the titles of document sections.

It is possible to limit the maximum section level for which the numbers are added. For those sections that are auto-numbered, the "autonum" attribute is set, informing the contents table generator that a different form of the TOC should be used.

Method apply Override to apply the transform to the document tree.
Method update_section_numbers Undocumented
Class Variable default_priority Should be applied before Contents.
Instance Variable maxdepth Undocumented
Instance Variable prefix Undocumented
Instance Variable startvalue Undocumented
Instance Variable suffix Undocumented

Inherited from Transform:

Method __init__ Initial setup for in-place document transforms.
Instance Variable document The document tree to transform.
Instance Variable language Language module local to this document.
Instance Variable startnode Node from which to begin the transform. For many transforms which apply to the document as a whole, startnode is not set (i.e. its value is None).
def apply(self): (source)
overrides docutils.transforms.Transform.apply

Override to apply the transform to the document tree.

def update_section_numbers(self, node, prefix=(), depth=0): (source)

Undocumented

default_priority: int = (source)
overrides docutils.transforms.Transform.default_priority

Should be applied before Contents.

maxdepth = (source)

Undocumented

prefix = (source)

Undocumented

startvalue = (source)

Undocumented

suffix = (source)

Undocumented