sphinx 生成类模块概述

Question

我希望 sphinx 生成一个类似于 doxygen 生成的模块概述，这里是 example

我不知道 sphinx 是怎么做到的

我可以使用 Graphviz 生成某种图表，但我找不到一种方法来获取图表中的可点击对象，该对象的操作方式与上述示例相同。

有什么方法可以直接在 sphinx 中执行此操作，或者通过一些 hack 使其作为 doxygen 模块概述工作？

Answer 1

Sphinx 有一个内置的 extensionsphinx.ext.inheritance_diagram，它使用 Graphviz。它定义了一个指令：inheritance-diagram。这是一个如何在 .rst 文件中使用它的示例：

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

以下是 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

---

还有一个“通用”sphinx.ext.graphviz 扩展用于在文档中嵌入图表。