関数を一つ持っている、Pythonモジュールです。この関数は初期化時に一つの引数を伴って呼び出されます。この引数はapplicationオブジェクトで、Sphinxのプロセスに関する情報を持っています。与えられた名前を持っている拡張機能をロードします。作成中の拡張機能が、他の拡張の機能を利用している場合に、このメソッドを使用してください。新しいビルダーを登録します。クラスを継承してクラスでなければなりません。新しい設定値を登録します。Sphinxが新しい設定値を認識して、関連するデフォルト値を設定するのに必要になります。拡張機能名を最初に入れてください。値には、Pythonであれば自由に設定することが可能です。値は文字列で、以下の値のうちの一つを取ります。設定を変更してからビルドをかけると、環境全体が再ビルドされます。この設定を変更してからビルドをかけた場合、出力がHTMLの時にフル再ビルドされます。設定を変更してもなにも再ビルドに関しては影響を与えません。値が呼び出し可能オブジェクトの場合には、設定オブジェクトを引数に渡して呼び出しを行い、デフォルト値を取得します。これは、他の値に依存してデフォルト値を変更したい場合に使用することができます。相当)から文字列に変更されました。後方互換性のために、ブーリアン型も受け取ることが可能で、その場合には内部で変換されます。**kwds)¶Docutilsのノードクラスを登録します。これはDocutils内部で使用するために必要です。将来的にはパースされたドキュメントにおける、ノード検証に使用されるかもしれません。テキストなど、出力形式ごとにノードのビジター関数を与えることができます。うちの一つ以上で、値としては、ノードに入ったときと出力したときのメソッドをそれぞれ1つずつ含む2要素のタプルを指定します。depart_math_html))もちろん、ビジターメソッドを定義しないトランスレータで実行していて、変換すべきドキュメントに遭遇するとビジターメソッドは沈黙します。ビジター関数を、キーワード引数を使って渡すことができるようになりました。directiveclass)Docutilsのディレクティブを登録します。ディレクティブ名として今後使っていく名前を設定します。関数の属性として設定されます。ディレクティブがコンテンツや引数、オプションを持っているか、それぞれ決定されます。いう、ディレクティブのためのクラスで定義します。これらの属性は、関数で登録する方法と同じ役割を持っています。ディレクティブクラスは通常、docutils.parsers.rst.Directiveクラスを継承しなければなりません。Sphinxの拡張機能を作成するために、ディレクティブを書く場合は、sphinx.util.compat.Directiveクラスを継承してください。0.4でも正しく動作します。0.5スタイルのディレクティブクラスがサポートされました。role)¶Docutilsのロールを登録します。ドキュメントのソースに表示されるロール名でなければなりません。ロールの関数を指定します。nodeclass)¶Docutilsのロールを登録します。使ってラップされるようになります。参照ノードクラス=None)¶このメソッドは、クロスリファレンスを作成することができる、新しい情報のタイプを追加することができる便利なメソッドです。指定された名前を持つ、新しいディレクティブを作成します。空でなければ、自動的に索引のエントリーに追加されます。一つだけ含まれていなければなりません。このテンプレートがどのように解釈されるかについては、この後のサンプルを参照してください。指定された名前を持つ、新しいロールが作成されます。これを使用すると、これらの説明ユニットに対するクロスリファレンスを張ることができます。指定する場合には、文字列と、docutilsのノードを受け取る関数を指定しなければなりません。ノードは、その文字列をパースして得られた子供のノードを受け取ります。この関数はクロスリファレンスと索引のエントリーで使用される名前を返さなければなりません。functionの説明。このクラスはコードの記述に適したプロポーショナルフォントでレンダリングされます。クラスは、docutilsのノードクラスを設定する必要があります。使用することもできます。非常に良く似ています。これは、セマンティックのターゲットをソースに追加して、カスタムのロールを使用して参照することができるということを意味しています。ような一般的なものは使用することができません。ディレクティブに続く要素はセクションでなくてもかまいません。transformのリストに追加します。これはSphinxがreST形式のドキュメントをパースした後に適用されます。ファイルを追加します。ここで指定されたファイルは、デフォルトのHTMLテンプレートの中にインクルードされます。ファイル名はHTMLの静的パスへの相対パスでなければなりません。