如何使用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脚本（可能使用自定义模板）执行此类操作。