.. _f-sphinxblocrefextension: module ``sphinxext.sphinx_blocref_extension`` ============================================= .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_blocref_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_blocref_extension`` Defines a :epkg:`sphinx` extension to keep track of blocs such as examples, FAQ, ... :githublink:`%|py|6` Classes +++++++ +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | class | truncated documentation | +=======================================================================================+==============================================================================================+ | :class:`BlocRef ` | A ``blocref`` entry, displayed in the form of an admonition. It takes the following options: | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :class:`blocref_node ` | Defines ``blocref`` node. | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :class:`BlocRefList ` | A list of all blocref entries, for a specific tag. | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :class:`blocreflist ` | defines ``blocreflist`` node | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ Functions +++++++++ +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +========================================================================================================================+=================================================================================================================================+ | :func:`depart_blocref_node ` | depart_blocref_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_blocreflist_node ` | depart_blocref_node | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`merge_blocref ` | merge_blocref | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_blocref_nodes ` | process_blocref_nodes | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_blocref_nodes_generic ` | process_blocref_nodes and other kinds of nodes, If the configuration file specifies a variable ``blocref_include_blocrefs`` ... | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_blocrefs ` | collect all blocrefs in the environment this is not done in the directive itself because it some transformations ... | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_blocrefs_generic ` | collect all blocrefs in the environment this is not done in the directive itself because it some transformations ... | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`purge_blocrefs ` | purge_blocrefs | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``blocref`` (sphinx) | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_blocref_node ` | visit_blocref_node | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_blocreflist_node ` | visit_blocreflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py | +------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +===========================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +===================================================================================================+===========================================================================================================+ | :py:meth:`_update_title ` | Updates the title for the bloc itself. | +---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`private_run ` | Builds a node :class:`blocref_node`. | +---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`run ` | Builds a node :class:`blocref_node`. | +---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`run ` | Simply insert an empty blocreflist node which will be replaced later when process_blocref_nodes is called | +---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_blocref_extension :members: :special-members: __init__ :show-inheritance: