.. _f-sphinxpostcontentsextension:

module ``sphinxext.sphinx_postcontents_extension``
==================================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_postcontents_extension


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

module ``pyquickhelper.sphinxext.sphinx_postcontents_extension``

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


:githublink:`%|py|7`




Classes
+++++++

+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| class                                                                                                        | truncated documentation                                       |
+==============================================================================================================+===============================================================+
| :class:`postcontents_node <pyquickhelper.sphinxext.sphinx_postcontents_extension.postcontents_node>`         | defines ``postcontents`` node                                 |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| :class:`PostContentsDirective <pyquickhelper.sphinxext.sphinx_postcontents_extension.PostContentsDirective>` | Defines a sphinx extension which proposes a new version of `` |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                          | truncated documentation                                                                                                                  |
+===================================================================================================================+==========================================================================================================================================+
| :func:`_modify_postcontents <pyquickhelper.sphinxext.sphinx_postcontents_extension._modify_postcontents>`         |                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`depart_postcontents_node <pyquickhelper.sphinxext.sphinx_postcontents_extension.depart_postcontents_node>` | does nothing                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_postcontents <pyquickhelper.sphinxext.sphinx_postcontents_extension.process_postcontents>`         | Collect all *postcontents* in the environment. Look for the section or document which contain them. Put them into ...                    |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_postcontents_extension.setup>`                                       | setup for ``postcontents`` (sphinx)                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`transform_postcontents <pyquickhelper.sphinxext.sphinx_postcontents_extension.transform_postcontents>`     | The function is called by event ``'doctree_resolved'``. It looks for every section in page stored in *postcontents_all_postcontents* ... |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`visit_postcontents_node <pyquickhelper.sphinxext.sphinx_postcontents_extension.visit_postcontents_node>`   | does nothing                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+-----------------------------------------------------------------------------------------------+----------------------------------------+
| method                                                                                        | truncated documentation                |
+===============================================================================================+========================================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_postcontents_extension.PostContentsDirective.run>` | Just add a :class:`postcontents_node`. |
+-----------------------------------------------------------------------------------------------+----------------------------------------+


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

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