sphinx.ext.inheritance_diagram

module documentation

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.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable module​_sig​_re Undocumented
Variable py​_builtins Undocumented
Class inheritance​_diagram A docutils node to use as a placeholder for the inheritance diagram.
Class ​Inheritance​Diagram Run when the inheritance_diagram directive is first encountered.
Class ​Inheritance​Exception Undocumented
Class ​Inheritance​Graph 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.
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.
module_sig_re =

Undocumented

py_builtins =

Undocumented

def get_graph_hash(node):

Undocumented

Parameters
node:inheritance_diagramUndocumented
Returns
strUndocumented
def html_visit_inheritance_diagram(self, node):
Output the graph for HTML. This will insert a PNG with clickable image map.
Parameters
node:inheritance_diagramUndocumented
def import_classes(name, currmodule):
Import a class using its fully-qualified name.
Parameters
name:strUndocumented
currmodule:strUndocumented
Returns
AnyUndocumented
def latex_visit_inheritance_diagram(self, node):
Output the graph for LaTeX. This will insert a PDF.
Parameters
node:inheritance_diagramUndocumented
def setup(app):

Undocumented

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

Undocumented

Parameters
node:inheritance_diagramUndocumented
def texinfo_visit_inheritance_diagram(self, node):
Output the graph for Texinfo. This will insert a PNG.
Parameters
node:inheritance_diagramUndocumented
def try_import(objname):

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