module sphinxext.sphinx_toctree_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_toctree_extension
#directive-toctree>`_ Overwrites `toctree <https://www.sphinx-doc.org/en/master/markup/toctree.html directive to get catch exceptions when a document is processed inline.
Classes¶
class |
truncated documentation |
---|---|
Sphinx directive |
|
Overwrites toctree. The code is … |
|
Overwrites TocTreeCollector. … |
Functions¶
function |
truncated documentation |
---|---|
Setup for |
Properties¶
property |
truncated documentation |
---|---|
|
Reference to the |
|
Reference to the |
Methods¶
method |
truncated documentation |
---|---|
|
|
Build a TOC from the doctree and store it in the inventory. |
|
|
Documentation¶
#directive-toctree>`_ Overwrites `toctree <https://www.sphinx-doc.org/en/master/markup/toctree.html directive to get catch exceptions when a document is processed inline.
- class pyquickhelper.sphinxext.sphinx_toctree_extension.CustomAdaptersTocTree(env: BuildEnvironment)[source]¶
Bases:
TocTree
Sphinx directive
- class pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
TocTree
Overwrites toctree. The code is located at sphinx/directives/other.py.
- option_spec = {'caption': <function unchanged_required>, 'glob': <function flag>, 'hidden': <function flag>, 'includehidden': <function flag>, 'maxdepth': <class 'int'>, 'name': <function unchanged>, 'numbered': <function int_or_nothing>, 'reversed': <function flag>, 'titlesonly': <function flag>}[source]¶
Mapping of option names to validator functions.
- class pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTreeCollector[source]¶
Bases:
TocTreeCollector
Overwrites TocTreeCollector.