module sphinxext.sphinx_toctree_extension

Inheritance diagram of pyquickhelper.sphinxext.sphinx_toctree_extension

Short summary

module pyquickhelper.sphinxext.sphinx_toctree_extension

Overwrites toctree directive to get catch exceptions when a document is processed inline.

source on GitHub

Classes

class

truncated documentation

CustomAdaptersTocTree

Sphinx directive

CustomTocTree

Overwrites toctree. The code is located …

CustomTocTreeCollector

Overwrites TocTreeCollector. …

Functions

function

truncated documentation

setup

Setup for toctree and toctree2 (sphinx).

Properties

property

truncated documentation

config

Reference to the Config object.

env

Reference to the BuildEnvironment object.

Methods

method

truncated documentation

enable

process_doc

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

run

Documentation

Overwrites toctree directive to get catch exceptions when a document is processed inline.

source on GitHub

class pyquickhelper.sphinxext.sphinx_toctree_extension.CustomAdaptersTocTree(env: BuildEnvironment)[source][source]

Bases: sphinx.environment.adapters.toctree.TocTree

Sphinx directive

class pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source][source]

Bases: sphinx.directives.other.TocTree

Overwrites toctree. The code is located at sphinx/directives/other.py.

source on GitHub

class pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTreeCollector[source][source]

Bases: sphinx.environment.collectors.toctree.TocTreeCollector

Overwrites TocTreeCollector.

source on GitHub

process_doc(app, doctree)[source][source]

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

pyquickhelper.sphinxext.sphinx_toctree_extension.setup(app)[source][source]

Setup for toctree and toctree2 (sphinx).

source on GitHub