我希望sphinx能够生成类似于doxygen生成的模块概述,这里是example
我无法找到狮身人面像如何做到这一点
我可以使用Graphviz生成某种图形,但是我无法找到一种方法来获取图形中的可点击对象,其操作方式与上面的示例相同。
有没有办法直接在sphinx中执行此操作,或者使用某些hack使其作为doxygen模块概述工作?
答案 0 :(得分:11)
Sphinx有一个名为extension的内置sphinx.ext.inheritance_diagram,它使用Graphviz。它定义了一个指令:inheritance-diagram
。以下是如何在.rst文件中使用它的示例:
.. inheritance-diagram:: mymodule.MyClass1 mymodule.MyClass2
:parts: 1
以下是Sphinx生成的文档中的继承图的一些示例:
还有一个“通用”sphinx.ext.graphviz扩展程序,用于在文档中嵌入图形。