.. _f-sphinxtoctreeextension:

module ``sphinxext.sphinx_toctree_extension``
=============================================





.. inheritance-diagram:: pyquickhelper.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.


:githublink:`%|py|8`




Classes
+++++++

+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                     | truncated documentation                                                                                                         |
+===========================================================================================================+=================================================================================================================================+
| :class:`CustomAdaptersTocTree <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomAdaptersTocTree>`   | :epkg:`Sphinx` directive                                                                                                        |
+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :class:`CustomTocTree <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree>`                   | Overwrites `toctree <https://www.sphinx-doc.org/en/master/markup/toctree.html#directive-toctree>`_. The code is ...             |
+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :class:`CustomTocTreeCollector <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTreeCollector>` | Overwrites `TocTreeCollector <https://github.com/sphinx-doc/sphinx/blob/master/sphinx/environment/collectors/toctree.py>`_. ... |
+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------+--------------------------------------------------+
| function                                                               | truncated documentation                          |
+========================================================================+==================================================+
| :func:`setup <pyquickhelper.sphinxext.sphinx_toctree_extension.setup>` | Setup for ``toctree`` and ``toctree2`` (sphinx). |
+------------------------------------------------------------------------+--------------------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------------------+-----------------------------------------------------+
| property                                                                               | truncated documentation                             |
+========================================================================================+=====================================================+
| :meth:`config <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree.config>` | Reference to the :class:`.Config` object.           |
+----------------------------------------------------------------------------------------+-----------------------------------------------------+
| :meth:`env <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree.env>`       | Reference to the :class:`.BuildEnvironment` object. |
+----------------------------------------------------------------------------------------+-----------------------------------------------------+






Methods
+++++++

+-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
| method                                                                                                    | truncated documentation                                     |
+===========================================================================================================+=============================================================+
| :meth:`enable <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTreeCollector.enable>`           |                                                             |
+-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`process_doc <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTreeCollector.process_doc>` | Build a TOC from the doctree and store it in the inventory. |
+-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree.run>`                          |                                                             |
+-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.sphinxext.sphinx_toctree_extension
    :members:
    :special-members: __init__
    :show-inheritance: