python-sphinx - 如何使用 sphinx 为每个模块生成一页

Question

我们使用 Sphinx 来生成我们的 Python 文档。

这是我们使用的命令行：

sphinx-apidoc -F -o %WORKSPACE%\docs_rst %PACKAGE%

sphinx-build -b html %WORKSPACE%\docs_rst %WORKSPACE%\docs

问题是我们每个包只有一页。但是，我们真正需要的是每个模块一页，否则页面会变得太长。

请问我该如何设置？

Answer 1

我已经向 Sphinx 提交了一个补丁来完全满足您的要求——它向 apidoc 添加了一个命令行选项，它将每个模块放在自己的页面上。

补丁可以在这里查看：https ://bitbucket.org/birkenfeld/sphinx/pull-request/161/added-option-to-apidoc-to-write-each

它目前正在等待合并到 Sphinx 中，该命令将添加一个单独的标签，这样可以正常工作：

sphinx-apidoc -o [output_dir] [package_dir] --separate

Answer 2

您也许可以使用autosummary扩展和sphinx-autogen脚本（可能使用自定义模板）来执行类似的操作。