从epydoc转到sphinx，自动记录一个简单的python .py文件。

Question

即使在应用补丁之后，Epydoc也不再能正常工作了，所以我想转移到狮身人面像。

我想从一个简单的python文件自动生成文档: test.py。

在安装和运行sphinx-快速启动脚本之后，我将test.py复制到源文件夹并键入：

狮身人面像-构建-b html .\source .\build

但是它只生成极小的html文件，而不解析test.py文件。

我的想法用完了。

(谢谢你的帮助:)

Answer 1

您必须将sphinx.ext.autodoc作为扩展包含在conf.py (https://www.sphinx-doc.org/en/master/usage/configuration.html)中，这样才能使用.. automodule::指令(或该模块中的对象具有.. autoclass::、.. autofunction::、.)来记录模块。

请参阅https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

Answer 2

要自动生成必要的.rst文件，可以使用狮身人面像。

这样生活就容易多了。因此，您不必手动记录每个模块。