.. _f-sphinxexthelper: module ``sphinxext.sphinx_ext_helper`` ====================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_ext_helper Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_ext_helper`` Few helpers for :epkg:`Sphinx`. :githublink:`%|py|5` Classes +++++++ +------------------------------------------------------------------------------+----------------------------------------+ | class | truncated documentation | +==============================================================================+========================================+ | :class:`NodeEnter ` | Returned by function :func:`traverse`. | +------------------------------------------------------------------------------+----------------------------------------+ | :class:`NodeLeave ` | Returned by function :func:`traverse`. | +------------------------------------------------------------------------------+----------------------------------------+ | :class:`TinyNode ` | Returned by :func:`traverse`. | +------------------------------------------------------------------------------+----------------------------------------+ | :class:`WrappedNode ` | Wraps a docutils node. | +------------------------------------------------------------------------------+----------------------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | function | truncated documentation | +===============================================================================+====================================================================================================+ | :func:`_get_data ` | Loads file ``objects.inv`` generated by extension :epkg:`sphinx.ext.intersphinx`. | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | :func:`get_index ` | Retrieves documentation data for a specific module. | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | :func:`info_blocref ` | Log information with :epkg:`Sphinx`. | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | :func:`sphinx_lang ` | Returns the language defined in the configuration file. | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | :func:`traverse ` | Enumerates through all children but insert a node whenever digging or leaving the childrens nodes. | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ Methods +++++++ +--------------------------------------------------------------------------------------+-------------------------+ | method | truncated documentation | +======================================================================================+=========================+ | :py:meth:`__init__ ` | Create a note | +--------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`__init__ ` | Create a note | +--------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`__init__ ` | Create a note | +--------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------+-------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_ext_helper :members: :special-members: __init__ :show-inheritance: