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

Question

即使在应用修补程序后，Epydoc仍然无法正常工作，所以我正尝试移动到Sphinx。

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

安装和运行狮身人面像 - 快速入门脚本我复制test.py到源文件夹后和类型：。

狮身人面像，打造-b HTML \源\建立

但它只产生minimiun HTML文件，并且它不解析test.py文件

我江郎才尽。

感谢您的帮助:)

Answer 1

你必须包括sphinx.ext.autodoc作为一个扩展您的conf.py（http://sphinx.pocoo.org/config.html#confval-extensions），比你可以使用.. automodule::指令（或物体从该模块.. autoclass::，.. autofunction::记录您的模块， ...）。

见http://sphinx.pocoo.org/ext/autodoc.html

Answer 2

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

这让生活变得更加轻松。所以你不必手动记录你的每个模块。