sphinx 生成類模塊概述

Question

我希望 sphinx 生成一個類似於 doxygen 生成的模塊概述，這是一個示例

我找不到獅身人面像如何做到這一點

我可以使用 Graphviz 來生成某種圖形，但我找不到一種方法來在圖形中獲得一個可點擊的對象，該對象的操作方式與上面的示例相同。

有什么辦法可以直接在 sphinx 中做到這一點，或者通過一些 hack 使其作為 doxygen 模塊概述工作？

Answer 1

Sphinx 有一個名為sphinx.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擴展用於在文檔中嵌入圖形。