.. _f-sphinxcmdrefextension:

module ``sphinxext.sphinx_cmdref_extension``
============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_cmdref_extension


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

module ``pyquickhelper.sphinxext.sphinx_cmdref_extension``

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


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| class                                                                              | truncated documentation                                                                                                 |
+====================================================================================+=========================================================================================================================+
| :class:`CmdRef <pyquickhelper.sphinxext.sphinx_cmdref_extension.CmdRef>`           | A ``cmdref`` entry, displayed in the form of an admonition. It is used to reference a script a module is added as a ... |
+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`cmdref_node <pyquickhelper.sphinxext.sphinx_cmdref_extension.cmdref_node>` | defines ``cmdref`` node                                                                                                 |
+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`CmdRefList <pyquickhelper.sphinxext.sphinx_cmdref_extension.CmdRefList>`   | A list of all *cmdref* entries, for a specific tag.                                                                     |
+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`cmdreflist <pyquickhelper.sphinxext.sphinx_cmdref_extension.cmdreflist>`   | defines ``cmdreflist`` node                                                                                             |
+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                | truncated documentation                                                                                                            |
+=========================================================================================================+====================================================================================================================================+
| :func:`depart_cmdref_node <pyquickhelper.sphinxext.sphinx_cmdref_extension.depart_cmdref_node>`         | *depart_cmdref_node*, see `sphinx/writers/html.py <https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py>`_. ... |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`depart_cmdreflist_node <pyquickhelper.sphinxext.sphinx_cmdref_extension.depart_cmdreflist_node>` | *depart_cmdref_node*                                                                                                               |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`merge_cmdref <pyquickhelper.sphinxext.sphinx_cmdref_extension.merge_cmdref>`                     | merge_cmdref                                                                                                                       |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_cmdref_nodes <pyquickhelper.sphinxext.sphinx_cmdref_extension.process_cmdref_nodes>`     | process_cmdref_nodes                                                                                                               |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_cmdrefs <pyquickhelper.sphinxext.sphinx_cmdref_extension.process_cmdrefs>`               | Collect all cmdrefs in the environment this is not done in the directive itself because it some transformations ...                |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`purge_cmdrefs <pyquickhelper.sphinxext.sphinx_cmdref_extension.purge_cmdrefs>`                   | purge_cmdrefs                                                                                                                      |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_cmdref_extension.setup>`                                   | setup for ``cmdref`` (sphinx)                                                                                                      |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`visit_cmdref_node <pyquickhelper.sphinxext.sphinx_cmdref_extension.visit_cmdref_node>`           | visit_cmdref_node                                                                                                                  |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :func:`visit_cmdreflist_node <pyquickhelper.sphinxext.sphinx_cmdref_extension.visit_cmdreflist_node>`   | visit_cmdreflist_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_cmdref_extension.cmdref_node.document>` | Return the `document` root node of the tree containing this Node. |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_cmdref_extension.cmdreflist.document>`  | Return the `document` root node of the tree containing this Node. |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------+






Methods
+++++++

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


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

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