.. _f-sphinxtodoextextension: module ``sphinxext.sphinx_todoext_extension`` ============================================= .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_todoext_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_todoext_extension`` Defines a sphinx extension to give a title to a todo, inspired from `todo.py `_. :githublink:`%|py|7` Classes +++++++ +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | class | truncated documentation | +=======================================================================================+==============================================================================================+ | :class:`TodoExt ` | A ``todoext`` entry, displayed in the form of an admonition. It takes the following options: | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :class:`todoext_node ` | Defines ``todoext`` node. | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :class:`TodoExtList ` | A list of all todoext entries, for a specific tag. | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :class:`todoextlist ` | Defines ``todoextlist`` node. | +---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ Functions +++++++++ +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +============================================================================================================+======================================================================================================================+ | :func:`depart_todoext_node ` | depart_todoext_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`depart_todoextlist_node ` | depart_todoext_node | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`merge_todoext ` | merge_todoext | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`process_todoext_nodes ` | process_todoext_nodes | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`process_todoexts ` | collect all todoexts in the environment this is not done in the directive itself because it some transformations ... | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`purge_todosext ` | purge_todosext | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | Setup for ``todoext`` (sphinx). | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`visit_todoext_node ` | visit_todoext_node | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :func:`visit_todoextlist_node ` | visit_todoextlist_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 | +================================================================================+===========================================================================================================+ | :meth:`run ` | builds the todo text | +--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`run ` | Simply insert an empty todoextlist node which will be replaced later when process_todoext_nodes is called | +--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_todoext_extension :members: :special-members: __init__ :show-inheritance: