module sphinxext.sphinx_bigger_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_bigger_extension
Defines a sphinx extension to display bigger text.
Classes¶
class |
truncated documentation |
---|---|
Defines bigger node. |
Functions¶
function |
truncated documentation |
---|---|
Defines custom role bigger. The following instructions defines buttons of size 20 (text): |
|
depart bigger_node for format other than html |
|
what to do when leaving a node bigger the function should have different behaviour, depending on the format, or … |
|
depart bigger_node for latex |
|
depart bigger_node for rst |
|
setup for |
|
what to do when visiting a node bigger the function should have different behaviour, depending on the format, … |
|
what to do when visiting a node bigger the function should have different behaviour, depending on the format, … |
|
what to do when visiting a node bigger the function should have different behaviour, depending on the format, … |
Documentation¶
Defines a sphinx extension to display bigger text.
-
class
pyquickhelper.sphinxext.sphinx_bigger_extension.
bigger_node
(rawsource='', *children, **attributes)[source]¶ Bases:
docutils.nodes.Element
Defines bigger node.
-
pyquickhelper.sphinxext.sphinx_bigger_extension.
bigger_role
(role, rawtext, text, lineno, inliner, options=None, content=None)[source]¶ Defines custom role bigger. The following instructions defines buttons of size 20 (text):
:bigger:`text`
Or to specify a different size :
:bigger:`::5:size`
- 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_bigger_extension.
depart_bigger_node
(self, node)[source]¶ depart bigger_node for format other than html
-
pyquickhelper.sphinxext.sphinx_bigger_extension.
depart_bigger_node_html
(self, node)[source]¶ what to do when leaving a node bigger 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_bigger_extension.
depart_bigger_node_latex
(self, node)[source]¶ depart bigger_node for latex
-
pyquickhelper.sphinxext.sphinx_bigger_extension.
depart_bigger_node_rst
(self, node)[source]¶ depart bigger_node for rst
-
pyquickhelper.sphinxext.sphinx_bigger_extension.
visit_bigger_node
(self, node)[source]¶ what to do when visiting a node bigger the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
-
pyquickhelper.sphinxext.sphinx_bigger_extension.
visit_bigger_node_latex
(self, node)[source]¶ what to do when visiting a node bigger the function should have different behaviour, depending on the format, or the setup should specify a different function for each.