.. _f-sphinxquoteextension: module ``sphinxext.sphinx_quote_extension`` =========================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_quote_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_quote_extension`` Defines a :epkg:`sphinx` extension for a quote. :githublink:`%|py|6` Classes +++++++ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | class | truncated documentation | +=================================================================================+===============================================================================================+ | :class:`quote_node ` | Defines ``quote`` node. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :class:`QuoteNode ` | A ``quotedef`` entry, displayed in the form of an admonition. It takes the following options: | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ Functions +++++++++ +------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ | function | truncated documentation | +======================================================================================================+================================================================================================+ | :func:`depart_quote_node ` | depart_quote_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py | +------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ | :func:`depart_quote_node_rst ` | depart_quote_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py | +------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``mathdef`` (sphinx) | +------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ | :func:`visit_quote_node ` | visit_quote_node | +------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ | :func:`visit_quote_node_rst ` | visit_quote_node | +------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ Properties ++++++++++ +---------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +=======================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +----------------------------------------------------------------------------+--------------------------+ | method | truncated documentation | +============================================================================+==========================+ | :meth:`run ` | Builds the mathdef text. | +----------------------------------------------------------------------------+--------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_quote_extension :members: :special-members: __init__ :show-inheritance: