lib.roles.transforms.toc

See also

Registry-aware entry: Contents in Docutils components.

Django docutils table of contents helpers.

class django_docutils.lib.transforms.toc.Contents
class[source]
class[source]
class django_docutils.lib.transforms.toc.Contents

Bases: Contents

Helpers for rendering docutils table of contents from document tree.

Changes: - Remove unused autonum - PEP8 - Removed extra nodes.paragraph wrapping of list_item’s.

startnode: Node | None
attribute
attribute
startnode: Node | None

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).

build_contents(node, level=0)
method[source]
method[source]
build_contents(node, level=0)

Build nested bullet list from doctree content.

Parameters:

  • node (Node)

  • level (int)

Return type:

bullet_list | list[Any]