Sphinxドキュメントジェネレータでは、（再帰的に）パッケージ全体をインデックスに追加できますか？

Question

私のパッケージのドキュメントを生成したい。プロジェクトのすべてのファイルには、豊富なドキュメントが含まれています。私のプロジェクト全体をドキュメント作成インデックスにすばやく追加する方法はありますか？

可能な限り小さなプロジェクトで、プロジェクト全体のドキュメントを自動的に生成したいと思います。私はindex.rstに次の追加によって開始：

.. automodule:: mymodulename 
    :members: 

行っているように見えるそのすべてが__init__.pyファイル（ちょうどドキュメンテーション文字列）のドキュメントelenmentsである - 私はそれが他のすべてを文書化することができますどのような方法がありますか？私は絶対に私のパッケージに定義されたすべてを追加し、パッケージ内のすべての単一のクラス、定数、関数（など）を適切なインデックスに追加するようにしています。

これはできますか？

Answer 1

sphinx-apidocを使用できます。
official documentationから：sphinx-apidocは、autodoc拡張機能を使用して、他の自動APIドキュメントツールのスタイルでパッケージ全体を文書化するSphinxソースの自動生成ツールです。

使用例は、（プロジェクトのルートディレクトリから）次のようになります。

$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0' 

docディレクトリはすべて準備が内部で作成されます。
自動生成されたconf.pyファイルを編集してドキュメントの設定を調整することもできます。

その他の有用な情報はsimilar question posted hereにあります。