.. _f-sphinxepkgextension: module ``sphinxext.sphinx_epkg_extension`` ========================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_epkg_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_epkg_extension`` Defines a way to reference a package or a page in this package. :githublink:`%|py|6` Classes +++++++ +----------------------------------------------------------------------------------+-------------------------+ | class | truncated documentation | +==================================================================================+=========================+ | :class:`ClassStruct ` | Class as struct. | +----------------------------------------------------------------------------------+-------------------------+ | :class:`epkg_node ` | Defines *epkg* node. | +----------------------------------------------------------------------------------+-------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +===========================================================================================+=========================================================================================================================+ | :func:`depart_epkg_node ` | What to do when leaving a node *epkg*. | +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :func:`epkg_role ` | Defines custom role *epkg*. A list of supported urls must be defined in the configuration file. It wants to replace ... | +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``bigger`` (sphinx) | +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_epkg_node ` | What to do when visiting a node *epkg*. | +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +-------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +=====================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +------------------------------------------------------------------------------------------+---------------------------------------+ | method | truncated documentation | +==========================================================================================+=======================================+ | :py:meth:`__init__ ` | All arguments are added to the class. | +------------------------------------------------------------------------------------------+---------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_epkg_extension :members: :special-members: __init__ :show-inheritance: