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

Question

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

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

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

sphinx-build -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文件，可以使用sphinx-apidoc。

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