新しいモジュール（ファイル）ごとにsphinx-apidocを実行する必要がありますか？

Question

スフィンクスに精通している私は、ソースからスタブとクラスを自動的に生成するDoxygenを使用したドキュメントに慣れています。それは私がgitのにgit add fileにあなたが持っているだけのようsphinx-apidoc -o dir dirを実行する必要があり、それぞれの新しいモジュール/ファイルのようですスフィンクスで

は、この標準であるか、私が行方不明です設定フラグがあります。

私は、各コマンドを順番に実行するためにbash/batファイルを自動化することができます。私が何か悪いことをしているのであれば、私は不思議です。

私はこれらの拡張機能をオンにしてローカルパスをインポートしてもらえないかと尋ねる人もいます。

conf.py

import os 
import sys 
sys.path.insert(0, os.path.abspath('.')) 
extensions = [ 
    'sphinx.ext.autodoc', 
    'sphinx.ext.coverage', 
    'sphinx.ext.viewcode', 
] 

Answer 1

あなたはファイルごとにsphinx-apidocを実行する必要はありません。

sphinx-apidocは、見つかったすべてのモジュールを文書化するためにsphinx.ext.autodocを使用するソースファイルを生成します。 sphinx-apidoc-manual-pageそう

プロジェクトは基本的には、各モジュールのフォルダに__init__.pyファイルを追加しました意味標準のpythonモジュールとして編成されている場合。 sphinx-apidocはそれらを自動的に見つけるはずです。