sphinx-apidoc用法 - 多个源python目录

Question

所以我将python源文件放在两个不同的目录中： -

e.g。

~/work/myproject
~/.virtualenvs/myproject

如何使用sphinx-apidoc递归查看两个目录以生成我的reST文件？

显然，

sphinx-apidoc -o docs/source ~/work/myproject

完美无缺，但是当我试图跑

时

sphinx-apidoc -o docs/source ~/.virtualenvs/myproject

再次，sphinx告诉我“docs / source / modules.rst已经存在，跳过”当然这是正确的，因为我已经运行了sphinx-apidoc一次来生成它。

那么如何执行一次并在两个目录中搜索？

Answer 1

根据Sphinx apidoc documentation，命令行语法为：

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

更新：错误，请参阅以下@jgbarah的评论。

这意味着如果您想在两个单独的目录中记录源，您可以一次传递两个目录/路径名，如下所示：

sphinx-apidoc -o docs/source ~/work/myproject ~/.virtualenvs/myproject

改进了建议：

您可以在每个项目的文档中创建一个子目录。如下所示：

sphinx-apidoc -o docs/source/app1 ~/work/myproject1
sphinx-apidoc -o docs/source/app2 ~/work/myproject2

使用toctree，您可以指向两个子目录：

.. toctree::
    :maxdepth: 2

    app1/index.rst
    app2/index.rst