.. _f-sphinxexrefextension:

module ``sphinxext.sphinx_exref_extension``
===========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_exref_extension


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

module ``pyquickhelper.sphinxext.sphinx_exref_extension``

Defines a :epkg:`sphinx` extension to keep track of ex.


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| class                                                                           | truncated documentation                                                                    |
+=================================================================================+============================================================================================+
| :class:`ExRef <pyquickhelper.sphinxext.sphinx_exref_extension.ExRef>`           | A ``exref`` entry, displayed in the form of an admonition. It takes the following options: |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :class:`exref_node <pyquickhelper.sphinxext.sphinx_exref_extension.exref_node>` | defines ``exref`` ndoe                                                                     |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :class:`ExRefList <pyquickhelper.sphinxext.sphinx_exref_extension.ExRefList>`   | A list of all *exref* entries, for a specific tag.                                         |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :class:`exreflist <pyquickhelper.sphinxext.sphinx_exref_extension.exreflist>`   | defines ``exreflist`` node                                                                 |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| function                                                                                             | truncated documentation                                                                                             |
+======================================================================================================+=====================================================================================================================+
| :func:`depart_exref_node <pyquickhelper.sphinxext.sphinx_exref_extension.depart_exref_node>`         | depart_exref_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py                      |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`depart_exreflist_node <pyquickhelper.sphinxext.sphinx_exref_extension.depart_exreflist_node>` | depart_exref_node                                                                                                   |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`merge_exref <pyquickhelper.sphinxext.sphinx_exref_extension.merge_exref>`                     | merge_exref                                                                                                         |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`process_exref_nodes <pyquickhelper.sphinxext.sphinx_exref_extension.process_exref_nodes>`     | process_blocref_nodes                                                                                               |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`process_exrefs <pyquickhelper.sphinxext.sphinx_exref_extension.process_exrefs>`               | collect all *exref* in the environment this is not done in the directive itself because it some transformations ... |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`purge_exrefs <pyquickhelper.sphinxext.sphinx_exref_extension.purge_exrefs>`                   | purge_exrefs                                                                                                        |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_exref_extension.setup>`                                 | setup for ``exref`` (sphinx)                                                                                        |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`visit_exref_node <pyquickhelper.sphinxext.sphinx_exref_extension.visit_exref_node>`           | visit_exref_node                                                                                                    |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`visit_exreflist_node <pyquickhelper.sphinxext.sphinx_exref_extension.visit_exreflist_node>`   | visit_exreflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py                    |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+----------------------------------------------------------------------------+------------------------------------------------------------------------+
| method                                                                     | truncated documentation                                                |
+============================================================================+========================================================================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_exref_extension.ExRef.run>`     | calls run from :class:`BlocRef` and add defaut tag                     |
+----------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_exref_extension.ExRefList.run>` | calls run from :class:`BlocRefList` and add default tag if not present |
+----------------------------------------------------------------------------+------------------------------------------------------------------------+


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

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