module sphinxext.sphinx_gdot_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_gdot_extension
Defines a sphinx extension to show DOT graph with viz.js or graphviz.
Classes¶
class |
truncated documentation |
---|---|
defines |
|
A |
Functions¶
function |
truncated documentation |
---|---|
|
|
depart collapse_node |
|
depart collapse_node |
|
depart collapse_node |
|
setup for |
|
visit collapse_node, the function switches between graphviz.py … |
|
visit collapse_node |
|
visit collapse_node |
Documentation¶
Defines a sphinx extension to show DOT graph with viz.js or graphviz.
New in version 1.9.
-
class
pyquickhelper.sphinxext.sphinx_gdot_extension.
GDotDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
docutils.parsers.rst.Directive
A
gdot
node displays a DOT graph. The build choose SVG for HTML format and image for other format unless it is specified.format: SVG or HTML
- script: boolean or a string to indicate than the standard output
should only be considered after this substring
url: url to viz.js, only if format SVG is selected
Example:
.. gdot:: digraph foo { "bar" -> "baz"; }
Which gives:
The directive also accepts scripts producing dot graphs on the standard output. Option script must be specified. This extension loads sphinx.ext.graphviz if not added to the list of extensions:
Example:
.. gdot:: :format: png digraph foo { "bar" -> "baz"; }
-
node_class
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_gdot_extension.gdot_node
-
pyquickhelper.sphinxext.sphinx_gdot_extension.
depart_gdot_node_html
(self, node)[source]¶ depart collapse_node
-
pyquickhelper.sphinxext.sphinx_gdot_extension.
depart_gdot_node_html_svg
(self, node)[source]¶ depart collapse_node
-
pyquickhelper.sphinxext.sphinx_gdot_extension.
depart_gdot_node_rst
(self, node)[source]¶ depart collapse_node
-
class
pyquickhelper.sphinxext.sphinx_gdot_extension.
gdot_node
(rawsource='', *children, **attributes)[source]¶ Bases:
docutils.nodes.admonition
defines
gdot
node.
-
pyquickhelper.sphinxext.sphinx_gdot_extension.
visit_gdot_node_html
(self, node)[source]¶ visit collapse_node, the function switches between graphviz.py and the SVG format.
-
pyquickhelper.sphinxext.sphinx_gdot_extension.
visit_gdot_node_html_svg
(self, node)[source]¶ visit collapse_node