3.8. sphinx.ext.inheritance_diagram¶

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.