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

    app1/index.rst
    app2/index.rst