如何使用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-apidoc -o [output_dir] [package_dir] --separate

Answer 2

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