Sphinx generates an overview of class modules

Question

I would like sphinx to generate a module overview similar to the one created by doxygen, here is an example

I can not find how sphinx can do this

I could use Graphviz to generate some kind of graph, but I cannot find a way to get an object that can be clicked on a graph that works the same way as in the example above.

Is there a way to do this directly in sphinx or hack it so that it works as an overview of the doxygen module?

Answer 1

Sphinx has a built-in extension called sphinx.ext.inheritance_diagram that uses Graphviz. It defines one directive: inheritance-diagram . The following is an example of how you can use it in a .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.