所以我把python源文件放在两个不同的目录中:
例如

~/work/myproject
~/.virtualenvs/myproject

如何使用sphinx-apidoc递归地在两个目录中查找以生成rest文件?
显然,
sphinx-apidoc -o docs/source ~/work/myproject

工作得很好,但是当我试着跑的时候
sphinx-apidoc -o docs/source ~/.virtualenvs/myproject

同样,狮身人面像告诉我,“文档/源/模块。RST已经存在,跳过”,这当然是真的,就像我已经运行过的sphinx-apidoc一次生成它一样。
那么,如何执行一次并在两个目录中搜索呢?

最佳答案

根据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

09-03 22:14