module sphinxext.sphinx_collapse_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_collapse_extension
Defines a sphinx extension to hide / unhide section of the page.
Classes¶
class |
truncated documentation |
---|---|
defines |
|
A |
Functions¶
function |
truncated documentation |
---|---|
depart collapse_node |
|
depart collapse_node |
|
depart collapse_node |
|
setup for |
|
visit collapse_node |
|
visit collapse_node |
|
visit collapse_node |
Properties¶
property |
truncated documentation |
---|---|
|
Return the document root node of the tree containing this Node. |
Methods¶
method |
truncated documentation |
---|---|
Builds the collapse text. |
Documentation¶
Defines a sphinx extension to hide / unhide section of the page.
- class pyquickhelper.sphinxext.sphinx_collapse_extension.CollapseDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
A
collapse
adds hide/unhide button for a part of HTML page. It has no effect in other formats.legend: legend for the button, if not precise, it will be hide / unhide. Example:
:legend: hide/unhide
.hide: the text is shown by default unless this option is set up.
Example:
.. collapse:: :legend: hide/unhide some text to hide or unhide
Which gives:
some text to hide or unhide
- node_class[source]¶
alias of
collapse_node
- option_spec = {'class': <function class_option>, 'hide': <function unchanged>, 'legend': <function unchanged>}[source]¶
Mapping of option names to validator functions.
- class pyquickhelper.sphinxext.sphinx_collapse_extension.collapse_node(rawsource='', *children, **attributes)[source]¶
Bases:
admonition
defines
collapse
node.
- pyquickhelper.sphinxext.sphinx_collapse_extension.depart_collapse_node(self, node)[source]¶
depart collapse_node
- pyquickhelper.sphinxext.sphinx_collapse_extension.depart_collapse_node_html(self, node)[source]¶
depart collapse_node
- pyquickhelper.sphinxext.sphinx_collapse_extension.depart_collapse_node_rst(self, node)[source]¶
depart collapse_node
- pyquickhelper.sphinxext.sphinx_collapse_extension.visit_collapse_node(self, node)[source]¶
visit collapse_node
- pyquickhelper.sphinxext.sphinx_collapse_extension.visit_collapse_node_html(self, node)[source]¶
visit collapse_node