我们正在使用Sphinx生成我们的Python文档.
这是我们使用的命令行:
sphinx-apidoc -F -o %WORKSPACE%\docs_rst %PACKAGE%
sphinx-build -b html %WORKSPACE%\docs_rst %WORKSPACE%\docs
Run Code Online (Sandbox Code Playgroud)
问题是我们每个包得到一页.我们真正需要的是每个模块一页,否则页面会变得太长.
我该如何设置呢?
小智 11
我已经向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