いくつかのクラスを持つモジュールがあります。現在..automodule、モジュールの文書化に使用しています。各クラスに、クラス名を持つ独自のヘッダーセクションを持たせたいのですが。これは、次のように置き換えることで実現でき..automodule fooます。
Bar
===
..autoclass foo.Bar
Baz
===
..autoclass foo.Baz
...
ただし、これを行うすべてのモジュールのすべてのクラスを手動で一覧表示する必要があります。自動モジュールによって生成されたコンテンツをカスタマイズするための最良の方法は何ですか？
Sphinxは、ソースコードからAPIドキュメントを生成するためにEpydocやDoxygenほど簡単に使用することはできません。これは、さまざまな種類のツールです。
Sphinxは.rst（reStructuredText）ファイルで動作します。各クラスにクラス名を持つ独自の見出しを付けたい場合は、自分で見出しを追加して、を使用する必要があります.. autoclass::。だけではできません.. automodule::。はい、これは不便です（同様の感情がここに示されています）。この回答とこの回答も参照してください。
この問題は、Pythonコードをウォークスルーして.rst出力を生成するスクリプトによって軽減できます。Sphinxには、そのようなスクリプトsphinx-apidocがすでに付属しています。.. autoclass::ただし、ディレクティブは生成されず、。のみが生成されます.. automodule::。
出力できる別のスクリプトは次の.. autoclass::とおりです：https ：//github.com/PyMVPA/PyMVPA/blob/master/tools/apigen.py 。多分あなたはそれを使うことができます。