docutils.transforms.parts.SectNum Class Reference

Inheritance diagram for docutils.transforms.parts.SectNum:

Collaboration diagram for docutils.transforms.parts.SectNum:

Public Member Functions
	apply (self)
	update_section_numbers (self, node, prefix=(), depth=0)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Public Attributes
	maxdepth
	startvalue
	prefix
	suffix
	startnode
	document
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Static Public Attributes
int	default_priority = 710
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Detailed Description

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.

Member Function Documentation

apply()

docutils.transforms.parts.SectNum.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/transforms/parts.py