从 epydoc 移动到狮身人面像以自动记录一个简单的 python .py 文件



即使在应用补丁后,Epydoc 也不再正常工作,所以我正在尝试迁移到狮身人面像。

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

安装并运行狮身人面像快速入门脚本后,我将 test.py 复制到文件夹并键入:

sphinx-build -b html .\source .\build

但它只生成 minimiun html 文件,并且不解析 test.py 文件

我没主意了。

感谢您的帮助:)

您必须在

conf.py中包含sphinx.ext.autodoc作为扩展(https://www.sphinx-doc.org/en/master/usage/configuration.html),然后您可以使用.. automodule::指令(或使用此模块中的对象使用.. autoclass::.. autofunction::,...)记录模块。

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

要自动生成必要的.rst文件,您可以使用 sphinx-apidoc。

这使生活变得更加轻松。因此,您不必手动记录每个模块。