sphinx.ext.graphviz

module documentation

Allow graphviz-formatted graphs to be included in Sphinx-generated documents inline.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Clickable​Map​Definition A manipulator for clickable map file of graphviz.
Class graphviz Undocumented
Class ​Graphviz Directive to insert arbitrary dot markup.
Class ​Graphviz​Error Undocumented
Class ​Graphviz​Simple Directive to insert arbitrary dot markup.
Function align​_spec Undocumented
Function figure​_wrapper Undocumented
Function html​_visit​_graphviz Undocumented
Function latex​_visit​_graphviz Undocumented
Function man​_visit​_graphviz Undocumented
Function on​_build​_finished Undocumented
Function render​_dot Render graphviz code into a PNG or PDF output file.
Function render​_dot​_html Undocumented
Function render​_dot​_latex Undocumented
Function render​_dot​_texinfo Undocumented
Function setup Undocumented
Function texinfo​_visit​_graphviz Undocumented
Function text​_visit​_graphviz Undocumented
logger =

Undocumented

def align_spec(argument):

Undocumented

Parameters
argument:AnyUndocumented
Returns
strUndocumented
def figure_wrapper(directive, node, caption):

Undocumented

Parameters
directive:DirectiveUndocumented
node:graphvizUndocumented
caption:strUndocumented
Returns
nodes.figureUndocumented
def html_visit_graphviz(self, node):

Undocumented

Parameters
node:graphvizUndocumented
def latex_visit_graphviz(self, node):

Undocumented

Parameters
node:graphvizUndocumented
def man_visit_graphviz(self, node):

Undocumented

Parameters
node:graphvizUndocumented
def on_build_finished(app, exc):

Undocumented

Parameters
app:SphinxUndocumented
exc:ExceptionUndocumented
def render_dot(self, code, options, format, prefix='graphviz', filename=None):
Render graphviz code into a PNG or PDF output file.
Parameters
code:strUndocumented
options:DictUndocumented
format:strUndocumented
prefix:strUndocumented
filename:strUndocumented
Returns
Tuple[str, str]Undocumented
def render_dot_html(self, node, code, options, prefix='graphviz', imgcls=None, alt=None, filename=None):

Undocumented

Parameters
node:graphvizUndocumented
code:strUndocumented
options:DictUndocumented
prefix:strUndocumented
imgcls:strUndocumented
alt:strUndocumented
filename:strUndocumented
Returns
Tuple[str, str]Undocumented
def render_dot_latex(self, node, code, options, prefix='graphviz', filename=None):

Undocumented

Parameters
node:graphvizUndocumented
code:strUndocumented
options:DictUndocumented
prefix:strUndocumented
filename:strUndocumented
def render_dot_texinfo(self, node, code, options, prefix='graphviz'):

Undocumented

Parameters
node:graphvizUndocumented
code:strUndocumented
options:DictUndocumented
prefix:strUndocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented
def texinfo_visit_graphviz(self, node):

Undocumented

Parameters
node:graphvizUndocumented
def text_visit_graphviz(self, node):

Undocumented

Parameters
node:graphvizUndocumented