python - 从 epydoc 到 sphinx 以自动记录一个简单的 python .py 文件

Question

即使在应用补丁之后，Epydoc 也无法正常工作，所以我正在尝试迁移到 Sphinx。

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

安装并运行sphinx-quickstart-script后，我​​将test.py复制到源文件夹并输入：

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

但它只生成最小的 html 文件，它不解析test.py文件

我没有主意了。

谢谢你的帮助 ：）

Answer 1

您必须在您的（https://www.sphinx-doc.org/en/master/usage/configuration.htmlsphinx.ext.autodoc ）中包含扩展名，然后才能使用指令（或此模块中的对象）记录您的模块，, ...)。conf.py.. automodule::.. autoclass::.. autofunction::

见https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

Answer 2

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

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