module sphinxext.sphinx_gitlog_extension

Inheritance diagram of pyquickhelper.sphinxext.sphinx_gitlog_extension

Short summary

module pyquickhelper.sphinxext.sphinx_gitlog_extension

Defines a sphinx extension to display gitlog text.

source on GitHub

Classes

class

truncated documentation

gitlog_node

Defines gitlog node.

Functions

function

truncated documentation

depart_gitlog_node

depart gitlog_node for format other than html

depart_gitlog_node_html

what to do when leaving a node gitlog the function should have different behaviour, depending on the format, or …

depart_gitlog_node_latex

depart gitlog_node for latex

depart_gitlog_node_rst

depart gitlog_node for rst

gitlog_role

Defines custom role gitlog. The following instruction prints out the date of the last modification for the current …

setup

setup for gitlog (sphinx)

visit_gitlog_node

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, …

visit_gitlog_node_latex

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, …

visit_gitlog_node_rst

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, …

Documentation

Defines a sphinx extension to display gitlog text.

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node(self, node)[source][source]

depart gitlog_node for format other than html

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node_html(self, node)[source][source]

what to do when leaving a node gitlog the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

It does only html for the time being.

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node_latex(self, node)[source][source]

depart gitlog_node for latex

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node_rst(self, node)[source][source]

depart gitlog_node for rst

source on GitHub

class pyquickhelper.sphinxext.sphinx_gitlog_extension.gitlog_node(rawsource='', *children, **attributes)[source][source]

Bases: docutils.nodes.Element

Defines gitlog node.

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.gitlog_role(role, rawtext, text, lineno, inliner, options=None, content=None)[source][source]

Defines custom role gitlog. The following instruction prints out the date of the last modification for the current file.

:gitlog:`date`
Parameters
  • role – The role name used in the document.

  • rawtext – The entire markup snippet, with role.

  • text – The text marked with the role.

  • lineno – The line number where rawtext appears in the input.

  • inliner – The inliner instance that called us.

  • options – Directive options for customization.

  • content – The directive content for customization.

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.setup(app)[source][source]

setup for gitlog (sphinx)

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.visit_gitlog_node(self, node)[source][source]

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.visit_gitlog_node_latex(self, node)[source][source]

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_gitlog_extension.visit_gitlog_node_rst(self, node)[source][source]

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub