module sphinxext.sphinx_gitlog_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_gitlog_extension
Defines a sphinx extension to display gitlog text.
Classes¶
class |
truncated documentation |
---|---|
Defines gitlog node. |
Functions¶
function |
truncated documentation |
---|---|
depart gitlog_node for format other than html |
|
what to do when leaving a node gitlog the function should have different behaviour, depending on the format, or … |
|
depart gitlog_node for latex |
|
depart gitlog_node for rst |
|
Defines custom role gitlog. The following instruction prints out the date of the last modification for the current … |
|
setup for |
|
what to do when visiting a node gitlog the function should have different behaviour, depending on the format, … |
|
what to do when visiting a node gitlog the function should have different behaviour, depending on the format, … |
|
what to do when visiting a node gitlog the function should have different behaviour, depending on the format, … |
Properties¶
property |
truncated documentation |
---|---|
|
Return the document root node of the tree containing this Node. |
Documentation¶
Defines a sphinx extension to display gitlog text.
- pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node(self, node)[source]¶
depart gitlog_node for format other than html
- pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node_html(self, node)[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.
- pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node_latex(self, node)[source]¶
depart gitlog_node for latex
- pyquickhelper.sphinxext.sphinx_gitlog_extension.depart_gitlog_node_rst(self, node)[source]¶
depart gitlog_node for rst
- class pyquickhelper.sphinxext.sphinx_gitlog_extension.gitlog_node(rawsource='', *children, **attributes)[source]¶
Bases:
Element
Defines gitlog node.
- pyquickhelper.sphinxext.sphinx_gitlog_extension.gitlog_role(role, rawtext, text, lineno, inliner, options=None, content=None)[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.
- pyquickhelper.sphinxext.sphinx_gitlog_extension.visit_gitlog_node(self, node)[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.
- pyquickhelper.sphinxext.sphinx_gitlog_extension.visit_gitlog_node_latex(self, node)[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.