sphinx-apidoc使用.多源python目录

Question

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

例如：

~/work/myproject
~/.virtualenvs/myproject

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

显然，

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

非常好，但是当我试图跑

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

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

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

Answer 1

根据狮身人面像文件，命令行语法是：

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::
    :maxdepth: 2

    app1/index.rst
    app2/index.rst