.. _f-sphinximageextension: module ``sphinxext.sphinx_image_extension`` =========================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_image_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_image_extension`` Defines a :epkg:`sphinx` extension to add button to share a page :githublink:`%|py|6` Classes +++++++ +-----------------------------------------------------------------------------------------------------+---------------------------------------------------+ | class | truncated documentation | +=====================================================================================================+===================================================+ | :class:`simpleimage_node ` | Defines *image* node. | +-----------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :class:`SimpleImageDirective ` | Adds an image to a page. It can be done by adding | +-----------------------------------------------------------------------------------------------------+---------------------------------------------------+ Functions +++++++++ +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +==============================================================================================================================+======================================================================================================================+ | :func:`_clean_value ` | | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_simpleimage_node_html ` | What to do when leaving a node *image* the function should have different behaviour, depending on the format, or ... | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_simpleimage_node_latex ` | What to do when leaving a node *image* the function should have different behaviour, depending on the format, or ... | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_simpleimage_node_md ` | What to do when leaving a node *image* the function should have different behaviour, depending on the format, or ... | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_simpleimage_node_rst ` | What to do when leaving a node *image* the function should have different behaviour, depending on the format, or ... | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_simpleimage_node_text ` | What to do when leaving a node *image* the function should have different behaviour, depending on the format, or ... | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`initialize_simpleimages_directive ` | Initializes the image directives. | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``image`` (sphinx) | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`visit_simpleimage_node ` | Visits a image node. Copies the image. | +------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +=============================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +---------------------------------------------------------------------------------------+-------------------------+ | method | truncated documentation | +=======================================================================================+=========================+ | :meth:`run ` | Runs the directive. | +---------------------------------------------------------------------------------------+-------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_image_extension :members: :special-members: __init__ :show-inheritance: