API Reference

Enhanced Sphinx TocTree which shows classes and functions as if they were sections.

Classes:

TocTreePlusCollector(​)

Subclass of sphinx.environment.collectors.toctree.TocTreeCollector that includes classes and functions in the toctree as if they were sections.

Functions:

setup(​app)

Setup Sphinx Extension.
class TocTreePlusCollector[source]

Bases: TocTreeCollector

Subclass of sphinx.environment.collectors.toctree.TocTreeCollector that includes classes and functions in the toctree as if they were sections.

Methods:

process_doc(​app, doctree)

Build a TOC from the doctree and store it in the inventory.
process_doc(app, doctree)[source]

Build a TOC from the doctree and store it in the inventory.

Parameters

  • app (Sphinx) – The Sphinx application.

  • doctree (document)

setup(app)[source]

Setup Sphinx Extension.

Parameters

app (Sphinx) – The Sphinx application.

Return type

Dict[str, Any]