可能ならリンクを生成します。可能ならリンクを生成します。可能ならリンクを生成します。以外の場合は、上記のキーワードのうち、どれかと、引数を一つが引数として設定されています。以下のロールを使用すると、モジュール内のオブジェクトを参照できます。一致する識別子が見つかれば、ハイパーリンクが作成されます::py:mod:¶モジュールへの参照です。ドットで区切られた名前も使用できます。これはパッケージ名としても利用可能です。:py:func:¶Pythonの関数への参照です。ドットで区切られた名前も使用できます。ロールのテキストは読みやすさのために括弧を後ろに含める必要はありません。``True``(デフォルト)にしておくと、Sphinxが自動で括弧を追加します。:py:data:¶モジュール変数を参照します。「定義済み」定数です。変更して欲しくないPythonの変数にも使えます。:py:class:¶クラス名です。ドットで区切られた名前も使用できます。:py:meth:¶オブジェクトのメソッドへの参照です。ロールのテキストには型名とメソッド名を含めなければなりません。型の記述中に書く場合には省略もできます。ドットで区切られた名前も使用できます。:py:attr:¶オブジェクトの属性への参照です。ドットで区切られた名前も使用できます。型が指定されていないオブジェクトの名前です。一緒に使用すると便利です。クラス名なども含めることができます。いう名前の関数か、その名前を持つ組み込み関数をあらわします。通常、これらのロールで使用される名前は、最初は修飾子なしで検索されます。次に現在のモジュール名を前に付けて検索されます。その次に現在のモジュール名とクラス名(あれば)を付けて検索されます。ドットが先頭についた名前が指定された場合には、この探索順は逆になります。参照するようになります。属性名が、現在のクラスのものかどうかを決定するのにも、同様の名前検索の仕組みが使用されます。オブジェクトの識別子の前に組み合わせることができます。C言語ドメイン¶C言語ドメイン(c)はC言語のAPIのドキュメントを書くのに適しています。prototype¶Cの関数の説明に使用します。シグニチャはC言語内で書かれる様に記述します。nitems)これは、関数のようなプリプロセッサマクロにも使用できます。説明の中で使用されることもあるため、引数名も書く必要があります。シグネチャ内のアスタリスクはバックスラッシュでエスケープする必要はありません。この中はreSTの行内のテキスト処理のパーサは実行されず、専用のパーサで処理されます。declaration¶C言語の構造体メンバーの説明をします。PyTypeObject.tp_bases説明のテキストには受け入れ可能な値の範囲、値がどのように解釈されるべきか、値が変更可能かどうかという情報を入れるべきです。ロールを使用すべきです。「シンプルな」C言語のマクロの説明をします。シンプルなマクロというのは、単純なコード展開だけをするもので、引数を取らず、そのため関数として説明できないものです。