name.モジュール用のマークアップ¶このセクションで説明するマークアップはドキュメントの書かれているモジュールに対して情報を提供するものです。名前¶このディレクティブはモジュールの説明の開始時に使用します。パッケージやサブモジュールにも使用できますが、この場合はパッケージ名を含む、完全な名前を指定してください。ディレクティブのようなコンテンツを作成することはできません。このディレクティブを使用すると、グローバルモジュールインデックスに項目が追加されます。オプションが存在していれば、そのモジュールが利用可能なモジュールをカンマ区切りで指定します。すべてのプラットフォームで利用可能であれば、このオプションは使用しないようにしましょう。“Unix”などから利用してください。適用時点ですでに使用されているキーがあれば、それを使用してください。オプションには、モジュールの目的を説明する文章を書くことができます。現在のバージョンでは、これはグローバルモジュールインデックスの中でのみ使用されます。オプションを使用すると、このモジュールが古くて、使用するのを推奨しない、ということを示すことができます。オプションは取りません。このディレクティブは様々な場所で使用されるでしょう。ように)の中にある、ということを通知します。これを使用しても、インデックスのエントリーは作成されません。リンクターゲットも作成されません。このディレクティブは、モジュールに含まれる項目へのドキュメントが様々なファイルやセクションに分割されている場合に便利です。使用するようにします。ディレクティブは何度も書くことができます。ドキュメントの一部に対して著者の名前を何人も指定できるように、モジュールコードの著者の名前を指定できます。設定値をTrueにすると出力されます。ノートこれは概要ファイルの目次のツリーに挿入されるようになります。モジュール説明ファイルのセクションタイトルの情報が増えるため、重要です。オブジェクト説明のためのディレクティブ¶モジュールに含まれる機能を説明するのに使用するディレクティブもいくつもあります。それぞれのディレクティブは、説明対象に関する基本情報を記述するためのシグニチャが1つ以上あります。基本バージョンは全体インデックスにエントリーを追加します。フラグをディレクティブのオプションすれば回避することができます。説明..ディレクティブには以下のものがあります。名前(シグニチャ)¶Cの関数の説明に使用します。シグニチャはC言語内で書かれる様に記述します。nitems)これは、関数のようなプリプロセッサマクロにも使用することができます。引き数名も書く必要があります。説明の中で使用されることもあります。シグネチャ内のアスタリスクはバックスラッシュでエスケープする必要はありません。この中はreSTの行内のテキスト処理のパーサは実行されず、専用のパーサで処理されます。名前¶Cの構造体メンバーの説明をします。PyTypeObject.tp_bases説明のテキストには受け入れ可能な値の範囲、値がどのように解釈されるべきか、値が変更可能かどうかという情報を入れるべきです。ロールを使用すべきです。“シンプルな”C言語のマクロの説明をします。シンプルなマクロというのは、単純なコード展開だけをするもので、引数を取ることはできません。単純な定数定義にも使用してはいけません。名前¶C言語の型を説明します。シグニチャには型名を指定します。名前¶グローバルなC言語の変数について説明します。シグニチャは型を含む必要があります。以下のように記述します。名前¶モジュール内のグローバルなデータの説明をします。変数も値も”定義された定数”として取り込むことができます。クラスとオブジェクトの属性はこの環境を使用してドキュメントを書くことはできません。例外クラスの説明をします。シグニチャには、コンストラクタの引数を括弧付きで含めることもできますが、しなくてもかまいません。名前(シグニチャ)¶モジュールレベル関数の説明です。シグニチャはパラメータを含めます。オプションのパラメータに対してはカッコでくくります。分かりやすさを上げる目的でデフォルト値を入れることもできます。説明も参照してください。number=1000000]])オブジェクトのメソッドはこのディレクティブではドキュメントを記述することはできません。モジュールの名前空間にあり、モジュールの公開インタフェースとして作成されているメソッドに限って使用することができます。これらは通常の関数とほぼ同じようにしようできます。説明にはパラメータに必要な関する情報と、それらがどのように使用されるのか(変更可能なオブジェクトが渡されたときに、変更されるのかどうか)、副作用、投げられる可能性のある例外の情報を含まなければなりません。小さいサンプルが提供されるでしょう。クラス名[(シグニチャ)]¶クラスについて説明します。シグニチャにはコンストラクタ引数になるパラメータも含めることができます。このクラスに属する属性とメソッドのディレクティブはこのディレクティブの本体の中に記述します。このクラスの外に書いた場合は、提供された名前にクラス名が含まれていれば、クロスリファレンスは動作します。Bar.quux()最初の書き方が推奨です。いう名前で提供されています。名前¶オブジェクトの属性のデータの説明をします。この説明には期待されるデータの型、値を直接変更することができるかどうか、という情報を含めます。名前(シグニチャ)¶オブジェクトのメソッドの説明をします。パラメータははずします。同じ情報を記述するようにします。一緒ですが、メソッドがスタティックメソッドであるということを表明します。一緒ですが、メソッドがクラスメソッドであるということを表明します。symbol]])このような省略可能な引数を表す場合には、慣習的にカンマの前に開きカッコを置きます。省略できる引数が二つ以上ある場合には、カッコを入れ子にするスタイルと、フラットにするスタイルの両方があります。このような場合にはほとんどの場合、オプションの引数は個別に与えることができます。symbol])¶オプション引数のデフォルト値を与えることもできます。値にカンマが含まれると、シグニチャのパーサはうまく動作しません。Pythonの3つのスタイルの引数のアノテーションと同様に、返り値の型も記述することができます。追加.オブジェクト説明のためのディレクティブの内側には、適切に情報が明示されたreSTフィールドを配置することができます。