package - 使用 Sphinx 为子包自动生成文档

Question

我的项目有几个包和子模块。它们都有文档字符串，所以我想为所有项目自动生成递归 sphinx 文档。

我看到有 autodoc 和 autosummary 扩展，但我无法让它们工作，也找不到关于此的明确指南。

有什么提示吗？

标签： packagepython-sphinx

Answer 1

从 3.1 版开始，如果您乐于使用它sphinx.ext.autosummary来显示汇总表，您可以使用新:recursive:选项自动检测包中的每个模块，无论嵌套多么深，并自动为其中的每个属性、类、函数和异常生成文档模块。

在这里查看我的答案，带有示例代码和结果：https ://stackoverflow.com/a/62613202/12014259