9

だから私は2つの異なるディレクトリに私のpythonソースファイルを持っています:-

例えば

~/work/myproject
~/.virtualenvs/myproject

sphinx-apidocreST ファイルを生成するために両方のディレクトリを再帰的に調べるにはどうすればよいですか?

明らかに、

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

完全に正常に動作しますが、実行しようとすると

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

繰り返しますが、sphinx は「docs/source/modules.rst が既に存在し、スキップしています」と表示します。これはもちろん、sphinx-apidoc一度実行して生成したことがあるからです。

では、一度実行して両方のディレクトリを検索するにはどうすればよいですか?

4

1 に答える 1

0

Sphinx apidocのドキュメントによると、コマンドライン構文は次のとおりです。

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

更新:間違っています。以下の@jgbarahによるコメントを参照してください。

これは、2つの別々のディレクトリにソースを文書化する場合、両方のディレクトリ/パス名を一度に渡すことができることを意味します。つまり、次のようになります。

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を使用すると、2つのサブディレクトリを指すことができます。

.. toctree::
    :maxdepth: 2

    app1/index.rst
    app2/index.rst
于 2012-11-18T17:58:29.057 に答える