.. _f-sphinxnbrefextension:

module ``sphinxext.sphinx_nbref_extension``
===========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_nbref_extension


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

module ``pyquickhelper.sphinxext.sphinx_nbref_extension``

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


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| class                                                                           | truncated documentation                                                                    |
+=================================================================================+============================================================================================+
| :class:`NbRef <pyquickhelper.sphinxext.sphinx_nbref_extension.NbRef>`           | A ``nbref`` entry, displayed in the form of an admonition. It takes the following options: |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :class:`nbref_node <pyquickhelper.sphinxext.sphinx_nbref_extension.nbref_node>` | defines ``nbref`` ndoe                                                                     |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :class:`NbRefList <pyquickhelper.sphinxext.sphinx_nbref_extension.NbRefList>`   | A list of all *nbref* entries, for a specific tag.                                         |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :class:`nbreflist <pyquickhelper.sphinxext.sphinx_nbref_extension.nbreflist>`   | defines ``nbreflist`` node                                                                 |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                             | truncated documentation                                                                                                              |
+======================================================================================================+======================================================================================================================================+
| :func:`depart_nbref_node <pyquickhelper.sphinxext.sphinx_nbref_extension.depart_nbref_node>`         | *depart_nbref_node*, see `sphinx/writers/html.py <https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py>`_. ...    |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`depart_nbreflist_node <pyquickhelper.sphinxext.sphinx_nbref_extension.depart_nbreflist_node>` | depart_nbref_node                                                                                                                    |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`merge_nbref <pyquickhelper.sphinxext.sphinx_nbref_extension.merge_nbref>`                     | merge_nbref                                                                                                                          |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_nbref_nodes <pyquickhelper.sphinxext.sphinx_nbref_extension.process_nbref_nodes>`     | process_nbref_nodes                                                                                                                  |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_nbrefs <pyquickhelper.sphinxext.sphinx_nbref_extension.process_nbrefs>`               | Collect all *nbref* in the environment this is not done in the directive itself because it some transformations ...                  |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`purge_nbrefs <pyquickhelper.sphinxext.sphinx_nbref_extension.purge_nbrefs>`                   | purge_nbrefs                                                                                                                         |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_nbref_extension.setup>`                                 | setup for ``nbref`` (sphinx)                                                                                                         |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`visit_nbref_node <pyquickhelper.sphinxext.sphinx_nbref_extension.visit_nbref_node>`           | visit_nbref_node                                                                                                                     |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :func:`visit_nbreflist_node <pyquickhelper.sphinxext.sphinx_nbref_extension.visit_nbreflist_node>`   | *visit_nbreflist_node*, see `sphinx/writers/html.py <https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py>`_. ... |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+----------------------------------------------------------------------------+------------------------------------------------------------------------+
| method                                                                     | truncated documentation                                                |
+============================================================================+========================================================================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_nbref_extension.NbRef.run>`     | calls run from :class:`BlocRef` and add index entries by default       |
+----------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_nbref_extension.NbRefList.run>` | calls run from :class:`BlocRefList` and add default tag if not present |
+----------------------------------------------------------------------------+------------------------------------------------------------------------+


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

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