docutils.transforms.parts.Contents Class Reference

Inheritance diagram for docutils.transforms.parts.Contents:

Collaboration diagram for docutils.transforms.parts.Contents:

Public Member Functions
	apply (self)
	build_contents (self, node, level=0)
	copy_and_filter (self, node)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Public Attributes
	toc_id
	backlinks
	startnode
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

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

Detailed Description

This transform generates a table of contents from the entire document tree
or from a single branch.  It locates "section" elements and builds them
into a nested bullet list, which is placed within a "topic" created by the
contents directive.  A title is either explicitly specified, taken from
the appropriate language module, or omitted (local table of contents).
The depth may be specified.  Two-way references between the table of
contents and section titles are generated (requires Writer support).

This transform requires a startnode, which contains generation
options and provides the location for the generated table of contents (the
startnode is replaced by the table of contents "topic").

Member Function Documentation

apply()

docutils.transforms.parts.Contents.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

copy_and_filter()

docutils.transforms.parts.Contents.copy_and_filter	(		self,
			node
	)

Return a copy of a title, with references, images, etc. removed.

---

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

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