.. _f-sphinxbiggerextension: module ``sphinxext.sphinx_bigger_extension`` ============================================ .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_bigger_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_bigger_extension`` Defines a :epkg:`sphinx` extension to display bigger text. :githublink:`%|py|6` Classes +++++++ +------------------------------------------------------------------------------------+-------------------------+ | class | truncated documentation | +====================================================================================+=========================+ | :class:`bigger_node ` | Defines *bigger* node. | +------------------------------------------------------------------------------------+-------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=============================================================================================================+=======================================================================================================================+ | :func:`bigger_role ` | Defines custom role *bigger*. The following instructions defines buttons of size 20 (:bigger:`text`): | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_bigger_node ` | depart bigger_node for format other than html | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_bigger_node_html ` | what to do when leaving a node *bigger* the function should have different behaviour, depending on the format, or ... | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_bigger_node_latex ` | depart bigger_node for latex | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_bigger_node_rst ` | depart bigger_node for rst | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``bigger`` (sphinx) | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`visit_bigger_node ` | what to do when visiting a node *bigger* the function should have different behaviour, depending on the format, ... | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`visit_bigger_node_latex ` | what to do when visiting a node *bigger* the function should have different behaviour, depending on the format, ... | +-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :func:`visit_bigger_node_rst ` | what to do when visiting a node *bigger* 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. | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_bigger_extension :members: :special-members: __init__ :show-inheritance: