追加.この拡張機能は、Epydocや他のAPIドキュメント生成ツールのような、関数、メソッド、属性のサマリーのリストを生成します。この機能は、作成中のシステムのdocstringが長く、詳細まで記述されていて、読みやすくするためにページを分けて出力されている場合に便利です。ディレクティブがあります。ディレクティブに列挙されているエントリーに対する短い"スタブ"ファイルを生成するために使うこともできます。ディレクティブにのみ含まれていますが、テンプレートでカスタマイズできます。autosummary::¶それぞれのアイテムごとに、ドキュメントされたアイテムとblurb(docstringの最初の文)を含むテーブルを挿入します。ファイルが自動的に生成されます。util.relative_uriこれは以下のようなテーブルを作成します:environment.BuildEnvironment([app])ReSTファイルが翻訳される環境。docstringとシグニチャの前処理を行います。スクリプトにも伝えられます。このオプションは、ディレクトリ名を引数として受け取ります。このディレクトリに出力します。引数が与えられなかった場合には、そのディレクティブが含まれているファイルがある、同じディレクトリに出力します。いう名前のテンプレートファイルを使用して、エントリーのすべてのリストのページを生成します。リストアップされた要素のためのドキュメントページのスタブを簡単に生成するのに使用されます。テーブルを読み込みます。ディレクトリに出力します。オプションで設定されたディレクトリにファイルを出力します。それぞれのスタブページを作成するかどうか決定します。スタブページを作成すべきドキュメントをリスト表示するのにも使えます。オプションで指定されたディレクトリに新しいファイルを配置します。セクションで説明しているのと同じ、Sphinxの標準的なHTMLのJinjaテンプレートを使って、スタブページのテンプレートをカスタマイズできます。サポートしていません。注釈もしも、スタブのテンプレートをカスタマイズするのに長い時間をかけているということが分かった場合には、autosummaryによる自動生成をやめて、自分でスタブを書いていく方がいいかもしれません。クラスメソッドのためのテンプレートテンプレートの中では以下の変数名が利用可能です:name¶ドキュメントの対象となっているオブジェクトの名前です。モジュールなやクラス名の部分は含まれません。objname¶ドキュメント対象となっているオブジェクトの名前です。モジュール名の部分は含まれません。fullname¶ドキュメント対象となっているオブジェクトの名前です。モジュール名、クラス名も含みます。module¶ドキュメント対象のオブジェクトが属しているモジュールの名前です。class¶ドキュメント対象のオブジェクトが属すクラスの名前です。メソッドと属性が対象の場合だけ利用できます。instead.members¶モジュールやクラスに属す、すべてのメンバーの名前のリストです。モジュールとクラスが対象の場合のみ利用できます。追加.functions¶モジュールの"公開"関数の名前を含むリストです。ここでの"公開"は、名前の最初の文字がアンダースコア以外のものを意味しています。対象がモジュールの場合のみ利用できます。classes¶モジュールの"公開"クラスの名前を含むリストです。対象がモジュールの場合のみ利用できます。exceptions¶モジュールの"公開"例外クラスの名前を含むリストです。対象がモジュールの場合のみ利用できます。methods¶クラスの"公開"メソッドの名前を含むリストです。対象がクラスの場合のみ利用できます。attributes¶クラスの"公開"属性の名前を含むリストです。対象がクラスの場合のみ利用できます。ディレクティブは、スタブページの中でも使用できます。スタブページは、これらのディレクティブを元に生成されます。