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

问题描述 投票:7回答:1

所以我的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来生成它。

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

python python-sphinx sphinx-apidoc
1个回答
0
投票

根据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
© www.soinside.com 2019 - 2024. All rights reserved.