gpt4 book ai didi

python - sphinx 生成类模块概述

转载 作者:太空狗 更新时间:2023-10-29 20:51:58 27 4
gpt4 key购买 nike

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

我找不到 sphinx 如何做到这一点

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

有没有什么方法可以直接在 sphinx 中做到这一点,或者有什么 hack 可以让它像 doxygen 模块概述一样工作?

最佳答案

Sphinx 有一个内置的 extension称为 sphinx.ext.inheritance_diagram使用Graphviz。它定义了一个指令:inheritance-diagram。以下是如何在 .rst 文件中使用它的示例:

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

以下是 Sphinx 生成的文档中的一些继承图示例:


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

关于python - sphinx 生成类模块概述,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/20487488/

27 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com