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-apidoc时，它告诉我“docs/source/modules.rst已经存在，跳过”，这当然是正确的，因为我已经运行过一次sphinx-apidoc来生成它。

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

- Calvin Cheng

---

你可以看一下这个问题：https://dev59.com/4m445IYBdhLWcg3w9Oss - jgbarah

Answer 1

根据Sphinx apidoc文档，命令行语法如下：

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

- Reinout van Rees

---

不行。根据Sphinx-apidoc man page，给出的任何路径名都是要从生成中排除的路径。所以，我猜那样做不行… - jgbarah