使用Sphinx自动生成子软件包的文档

时间:2020-04-02 12:53:02

标签: package python-sphinx

我的项目有几个软件包和子模块。它们都有文档字符串,所以我想为所有项目自动生成递归的狮身人面像文档。

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

有任何提示吗?

1 个答案:

答案 0 :(得分:0)

从3.1版开始,如果您乐意使用sphinx.ext.autosummary显示摘要表,则可以使用新的:recursive:选项自动检测包中的每个模块,无论它们嵌套的深度如何,并自动为该模块中的每个属性,类,函数和异常生成文档。

在此处查看我的答案,并提供示例代码和结果:https://stackoverflow.com/a/62613202/12014259