sphinx.ext.graphviz

module documentation
(source)

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

Class ClickableMapDefinition A manipulator for clickable map file of graphviz.
Class graphviz Undocumented
Class Graphviz Directive to insert arbitrary dot markup.
Class GraphvizSimple Directive to insert arbitrary dot markup.
Exception GraphvizError Undocumented
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
Variable logger Undocumented
def align_spec(argument): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
self:ManualPageTranslatorUndocumented
node:graphvizUndocumented
def on_build_finished(app, exc): (source)

Undocumented

Parameters
app:SphinxUndocumented
exc:ExceptionUndocumented
def render_dot(self, code, options, format, prefix='graphviz', filename=None): (source)

Render graphviz code into a PNG or PDF output file.

Parameters
self:SphinxTranslatorUndocumented
code:strUndocumented
options:dictUndocumented
format:strUndocumented
prefix:strUndocumented
filename:str|NoneUndocumented
Returns
tuple[str|None, str|None]Undocumented
def render_dot_html(self, node, code, options, prefix='graphviz', imgcls=None, alt=None, filename=None): (source)

Undocumented

Parameters
self:HTML5TranslatorUndocumented
node:graphvizUndocumented
code:strUndocumented
options:dictUndocumented
prefix:strUndocumented
imgcls:str|NoneUndocumented
alt:str|NoneUndocumented
filename:str|NoneUndocumented
Returns
tuple[str, str]Undocumented
def render_dot_latex(self, node, code, options, prefix='graphviz', filename=None): (source)

Undocumented

Parameters
self:LaTeXTranslatorUndocumented
node:graphvizUndocumented
code:strUndocumented
options:dictUndocumented
prefix:strUndocumented
filename:str|NoneUndocumented
def render_dot_texinfo(self, node, code, options, prefix='graphviz'): (source)

Undocumented

Parameters
self:TexinfoTranslatorUndocumented
node:graphvizUndocumented
code:strUndocumented
options:dictUndocumented
prefix:strUndocumented
def setup(app): (source)

Undocumented

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

Undocumented

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

Undocumented

Parameters
self:TextTranslatorUndocumented
node:graphvizUndocumented
logger = (source)

Undocumented