sphinx.ext.inheritance_diagram

module documentation
(source)

Defines a docutils directive for inserting inheritance diagrams. Provide the directive with one or more classes or modules (separated by whitespace). For modules, all of the classes in that module will be used. Example:: Given the following classes: class A: pass class B(A): pass class C(A): pass class D(B, C): pass class E(B): pass .. inheritance-diagram: D E Produces a graph like the following: A / \ B C / \ / E D The graph is inserted as a PNG+image map into HTML and a PDF in LaTeX.

Class inheritance_diagram A docutils node to use as a placeholder for the inheritance diagram.
Class InheritanceDiagram Run when the inheritance_diagram directive is first encountered.
Class InheritanceGraph Given a list of classes, determines the set of classes that they inherit from all the way to the root "object", and then is able to generate a graphviz dot graph from them.
Exception InheritanceException Undocumented
Function get_graph_hash Undocumented
Function html_visit_inheritance_diagram Output the graph for HTML. This will insert a PNG with clickable image map.
Function import_classes Import a class using its fully-qualified *name*.
Function latex_visit_inheritance_diagram Output the graph for LaTeX. This will insert a PDF.
Function setup Undocumented
Function skip Undocumented
Function texinfo_visit_inheritance_diagram Output the graph for Texinfo. This will insert a PNG.
Function try_import Import a object or module using *name* and *currentmodule*. *name* should be a relative name from *currentmodule* or a fully-qualified name.
Variable module_sig_re Undocumented
Variable py_builtins Undocumented
def get_graph_hash(node): (source)

Undocumented

Parameters
node:inheritance_diagramUndocumented
Returns
strUndocumented
def html_visit_inheritance_diagram(self, node): (source)

Output the graph for HTML. This will insert a PNG with clickable image map.

Parameters
self:HTML5TranslatorUndocumented
node:inheritance_diagramUndocumented
def import_classes(name, currmodule): (source)

Import a class using its fully-qualified *name*.

Parameters
name:strUndocumented
currmodule:strUndocumented
Returns
AnyUndocumented
def latex_visit_inheritance_diagram(self, node): (source)

Output the graph for LaTeX. This will insert a PDF.

Parameters
self:LaTeXTranslatorUndocumented
node:inheritance_diagramUndocumented
def setup(app): (source)

Undocumented

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

Undocumented

Parameters
self:nodes.NodeVisitorUndocumented
node:inheritance_diagramUndocumented
def texinfo_visit_inheritance_diagram(self, node): (source)

Output the graph for Texinfo. This will insert a PNG.

Parameters
self:TexinfoTranslatorUndocumented
node:inheritance_diagramUndocumented
def try_import(objname): (source)

Import a object or module using *name* and *currentmodule*. *name* should be a relative name from *currentmodule* or a fully-qualified name. Returns imported object or module. If failed, returns None value.

Parameters
objname:strUndocumented
Returns
AnyUndocumented
module_sig_re = (source)

Undocumented

py_builtins = (source)

Undocumented