sphinx.directives.other.TocTree

class documentation

class TocTree(SphinxDirective): (source)

View In Hierarchy

Directive to notify Sphinx about the hierarchical structure of the docs, and to include a table-of-contents like tree in the current document.

Method parse_content Undocumented
Method run Undocumented
Class Variable final_argument_whitespace Undocumented
Class Variable has_content Undocumented
Class Variable option_spec Undocumented
Class Variable optional_arguments Undocumented
Class Variable required_arguments Undocumented

Inherited from SphinxDirective:

Method get_location Get current location info for logging.
Method get_source_info Get source and line number.
Method set_source_info Set source and line number to the node.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def parse_content(self, toctree): (source)

Undocumented

Parameters
toctree:addnodes.toctreeUndocumented
Returns
list[Node]Undocumented
def run(self): (source)

Undocumented

Returns
list[Node]Undocumented
final_argument_whitespace: bool = (source)

Undocumented

has_content: bool = (source)

Undocumented

option_spec = (source)

Undocumented

optional_arguments: int = (source)

Undocumented

required_arguments: int = (source)

Undocumented