.. _f-sphinxsharenetextension: module ``sphinxext.sphinx_sharenet_extension`` ============================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_sharenet_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_sharenet_extension`` Defines a sphinx extension to add button to share a page :githublink:`%|py|6` Classes +++++++ +--------------------------------------------------------------------------------------------------+--------------------------------------------------------+ | class | truncated documentation | +==================================================================================================+========================================================+ | :class:`sharenet_node ` | Defines *sharenet* node. | +--------------------------------------------------------------------------------------------------+--------------------------------------------------------+ | :class:`ShareNetDirective ` | Adds buttons to share a page. It can be done by adding | +--------------------------------------------------------------------------------------------------+--------------------------------------------------------+ Functions +++++++++ +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=================================================================================================================+============================================================================================================================================+ | :func:`depart_sharenet_node ` | what to do when leaving a node sharenet the function should have different behaviour, depending on the format, or ... | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_sharenet_node_html ` | what to do when leaving a node sharenet the function should have different behaviour, depending on the format, or ... | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_sharenet_node_rst ` | what to do when leaving a node sharenet the function should have different behaviour, depending on the format, or ... | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``sharenet`` (sphinx) | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`sharenet_role ` | Defines custom roles *sharenet*. The following instructions defines buttons of size 20 (:sharenet:`facebook-linkedin-twitter-20-body`) ... | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_sharenet_node ` | what to do when visiting a node sharenet the function should have different behaviour, depending on the format, ... | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_sharenet_node_rst ` | what to do when visiting a node sharenet the function should have different behaviour, depending on the format, ... | +-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ 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 directve. | +---------------------------------------------------------------------------------------+-------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_sharenet_extension :members: :special-members: __init__ :show-inheritance: