sphinx generate class modules overview

Question

I\'d like sphinx to generate a module overview similar to the one generated by doxygen, here is an example

I can\'t find how sphinx can do that

I could use Graph

Answer 1

Sphinx has a built-in extension called sphinx.ext.inheritance_diagram that uses Graphviz. It defines one directive: inheritance-diagram. Here is an example of how you could use it in an .rst file:

.. inheritance-diagram:: mymodule.MyClass1 mymodule.MyClass2
   :parts: 1

Here are some examples of inheritance diagrams in documents generated by Sphinx:

• http://matplotlib.org/1.3.1/devel/documenting_mpl.html#inheritance-diagrams
• http://openalea.gforge.inria.fr/doc/vplants/PlantGL/doc/_build/html/user/math.html#class-inheritance-diagram

---

There is also a "generic" sphinx.ext.graphviz extension for embedding graphs in documentation.