.. _f-sphinxgitlogextension: module ``sphinxext.sphinx_gitlog_extension`` ============================================ .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_gitlog_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_gitlog_extension`` Defines a :epkg:`sphinx` extension to display gitlog text. :githublink:`%|py|6` Classes +++++++ +------------------------------------------------------------------------------------+-------------------------+ | class | truncated documentation | +====================================================================================+=========================+ | :class:`gitlog_node ` | Defines *gitlog* node. | +------------------------------------------------------------------------------------+-------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=============================================================================================================+==========================================================================================================================+ | :func:`depart_gitlog_node ` | depart *gitlog_node* for format other than html | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_gitlog_node_html ` | what to do when leaving a node *gitlog* the function should have different behaviour, depending on the format, or ... | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_gitlog_node_latex ` | depart *gitlog_node* for latex | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_gitlog_node_rst ` | depart *gitlog_node* for rst | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`gitlog_role ` | Defines custom role *gitlog*. The following instruction prints out the date of the last modification for the current ... | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``gitlog`` (sphinx) | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_gitlog_node ` | what to do when visiting a node *gitlog* the function should have different behaviour, depending on the format, ... | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_gitlog_node_latex ` | what to do when visiting a node *gitlog* the function should have different behaviour, depending on the format, ... | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_gitlog_node_rst ` | what to do when visiting a node *gitlog* 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_gitlog_extension :members: :special-members: __init__ :show-inheritance: