autodoc
と を使用して、Python 2.7 プロジェクトの Sphinx 駆動 (v1.3.1) ドキュメントをまとめていnapoleon
ます。1 つのディレクティブで文書化したい 1 つのモジュール内に、フラグautomodule::
を適用する特定のクラスがあります。with に:special-members:
フラグを立てると、モジュール内のすべてのスペシャルが表示されますが、これは良くありません。automodule::
:special-members:
これどうやってするの?
autoclass::
フラグが付けられたディレクティブを追加する:special-members:
と、コンテンツの一部として「専門化されていない」ドキュメントが残りautomodule::
、結果としてコンテンツが重複します。
:members:
の命令で、スペシャルを対象としたクラスを除いて、モジュール内のすべてのクラスを明示的に入力できると思いますが、モジュールにautomodule::
クラスを追加または削除するたびに、そのリストを更新することを忘れないでください。