module sphinxext.sphinx_bigger_extension

Short summary

module pyquickhelper.sphinxext.sphinx_bigger_extension

Defines a sphinx extension to display bigger text.

source on GitHub

Classes

class	truncated documentation
bigger_node	Defines bigger node.

Functions

function	truncated documentation
bigger_role	Defines custom role bigger. The following instructions defines buttons of size 20 (text):
depart_bigger_node	depart bigger_node for format other than html
depart_bigger_node_html	what to do when leaving a node bigger the function should have different behaviour, depending on the format, or …
depart_bigger_node_latex	depart bigger_node for latex
depart_bigger_node_rst	depart bigger_node for rst
setup	setup for bigger (sphinx)
visit_bigger_node	what to do when visiting a node bigger the function should have different behaviour, depending on the format, …
visit_bigger_node_latex	what to do when visiting a node bigger the function should have different behaviour, depending on the format, …
visit_bigger_node_rst	what to do when visiting a node bigger the function should have different behaviour, depending on the format, …

Properties

property	truncated documentation
document	Return the document node at the root of the tree containing this Node.

Documentation

Defines a sphinx extension to display bigger text.

source on GitHub

class pyquickhelper.sphinxext.sphinx_bigger_extension.bigger_node(rawsource='', *children, **attributes)

Bases: Element

Defines bigger node.

source on GitHub

__slotnames__ = []

pyquickhelper.sphinxext.sphinx_bigger_extension.bigger_role(role, rawtext, text, lineno, inliner, options=None, content=None)

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.

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.depart_bigger_node(self, node)

depart bigger_node for format other than html

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.depart_bigger_node_html(self, node)

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.

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.depart_bigger_node_latex(self, node)

depart bigger_node for latex

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.depart_bigger_node_rst(self, node)

depart bigger_node for rst

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.setup(app)

setup for bigger (sphinx)

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.visit_bigger_node(self, node)

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.

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.visit_bigger_node_latex(self, node)

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.

source on GitHub

pyquickhelper.sphinxext.sphinx_bigger_extension.visit_bigger_node_rst(self, node)

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.

source on GitHub