.. _f-sphinxtocdelayextension:

module ``sphinxext.sphinx_tocdelay_extension``
==============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_tocdelay_extension


Short summary
+++++++++++++

module ``pyquickhelper.sphinxext.sphinx_tocdelay_extension``

Defines a sphinx extension which proposes a new version of ``.. toctree::``
which takes into account titles dynamically added.


:githublink:`%|py|7`




Classes
+++++++

+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
| class                                                                                            | truncated documentation                                               |
+==================================================================================================+=======================================================================+
| :class:`tocdelay_node <pyquickhelper.sphinxext.sphinx_tocdelay_extension.tocdelay_node>`         | defines ``tocdelay`` node                                             |
+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :class:`TocDelayDirective <pyquickhelper.sphinxext.sphinx_tocdelay_extension.TocDelayDirective>` | Defines a :epkg:`sphinx` extension which proposes a new version of `` |
+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                    | truncated documentation                                                                                                          |
+=============================================================================================================+==================================================================================================================================+
| :func:`_print_loop_on_children <pyquickhelper.sphinxext.sphinx_tocdelay_extension._print_loop_on_children>` |                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`depart_tocdelay_node <pyquickhelper.sphinxext.sphinx_tocdelay_extension.depart_tocdelay_node>`       | does nothing                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_tocdelay <pyquickhelper.sphinxext.sphinx_tocdelay_extension.process_tocdelay>`               | Collect all *tocdelay* in the environment. Look for the section or document which contain them. Put them into the ...            |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_tocdelay_extension.setup>`                                     | setup for ``tocdelay`` (sphinx)                                                                                                  |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`transform_tocdelay <pyquickhelper.sphinxext.sphinx_tocdelay_extension.transform_tocdelay>`           | The function is called by event ``'doctree_resolved'``. It looks for every section in page stored in *tocdelay_all_tocdelay* ... |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`visit_tocdelay_node <pyquickhelper.sphinxext.sphinx_tocdelay_extension.visit_tocdelay_node>`         | does nothing                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| property                                                                                    | truncated documentation                                           |
+=============================================================================================+===================================================================+
| :meth:`document <pyquickhelper.sphinxext.sphinx_tocdelay_extension.tocdelay_node.document>` | Return the `document` root node of the tree containing this Node. |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+






Methods
+++++++

+---------------------------------------------------------------------------------------+------------------------------------------------------------------+
| method                                                                                | truncated documentation                                          |
+=======================================================================================+==================================================================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_tocdelay_extension.TocDelayDirective.run>` | Just add a :class:`tocdelay_node` and list the documents to add. |
+---------------------------------------------------------------------------------------+------------------------------------------------------------------+


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

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