name.パラグラフ階層のマークアップ¶これらのディレクティブは短いパラグラフ(段落)を作成します。通常のテキスト同様、情報の固まりに対して使用できます。特別に重要な情報が少しだけある場合に使用します。APIを使用する際に、ユーザが気をつけなければならないことの説明をする場合などに使うと良いでしょう。このディレクティブの中身には、適切に句読点が付いた、完全な文章を書くべきです。この関数はspamの電子メールを送付するには適しません。warning::¶noteよりも重要な情報があり、APIを使用する際に、気をつけなければならない警告情報をユーザに伝えるために使用するのに適しています。このディレクティブの中身には、適切に句読点が付いた、完全な文章を書くべきです。このディレクティブを使用する方が良いでしょう。APIに追加された時のプロジェクトのバージョンについて記述するのに使用します。このディレクティブがモジュール全体に対して適用する場合には、モジュールセクションの先頭の、文章が始まる前の位置に置くべきです。最初の引数は必須で、バージョン番号を書く必要があります。説明を書くことができます。似ていますが、現在説明している機能がいつどのように変化したのか(新しい引数、副作用の変更など)を説明するのに使用します。ディレクティブを使用して作ることができます。ディレクティブはサブセクションの直前のセクションに置かれることが多いです。HTMLアウトプットにおいては、メインのテキストの流れから離されて、箱に囲まれて表示されます。中身は、reSTの定義リストを使用しなければなりません。GNUによるtar拡張も含む、tarアーカイブファイルのドキュメント。タイトル¶このディレクティブは、目次に表示されないパラグラフの見出しを作成します。が”Footnotes”だった場合には、脚注の定義だけが含まれていると見なして、LaTeXライターでは無視されます。この場合は空の見出しだけが作成されます。centered::¶このディレクティブはセンターに置かれた、太字のテキストを作成するのに使用します。hlist::¶このディレクティブは短い文章のリストを含みます。このディレクティブは、水平にも数カラム展開することで、よりコンパクトなリストに変換するか、アイテム間のスペースを小さくします。どちらになるかはビルダー次第です。オプションを使用して、水平のカラム数の設定をすることができます。デフォルトでは2になっています。“Sphinxコンセプト”のドキュメントを読んでください。ディレクティブを使用してください。インデックス生成のためのマークアップ¶Sphinxはすべての情報のユニット(関数、クラス、属性)から、自動的にインデックスのエントリーを作成します。これ以外に明示的に指定するディレクティブもあります。これを使用することで、言語のリファレンスのように、メインの情報のユニットが存在しない情報をドキュメントの中に書いてインデックスのエントリーを作ることができるようになります。包括的なインデックスを作成することができるようになります。<エントリー>¶このディレクティブは一つ以上のインデックスのエントリーを含みます。それぞれのエントリーはコロン(:)で区切られた、タイプ、値を含みます。path実行時のコンテキスト---------------------...このディレクティブは5つのエントリーを含んでいます。これらは生成されたインデックスのエントリーに変換され、index文の正確な位置へのリンクが張られることになります。オフラインのメディアに出力される場合には、リンクの代わりに対応するページ番号が出力されます。置くことが大切になります。上記のサンプルコードの例では、リンクを張りたい見出しの前に配置されています。設定可能なエントリーのタイプは以下の通りです:single単体のインデックスのエントリーを作成します。サブエントリーのテキストとの間をセミコロンで区切ることにより、サブエントリーをサブエントリーを作ることもできます。この記法はどのエントリーが作成されたのか、という説明のところで詳しく説明します。インデックスエントリーを2つ作成します。2つのエントリーが作成されます。3つのエントリーを作成します。builtinこれらはすべて、2つのエントリーを作成します。2つのエントリーが作成されます。notationこれは4つのインデックスのエントリーが作成されます。glossary::¶このディレクティブは用語と定義がリストになった、reST定義リストを含みます。いうロールを利用することで参照が可能になります。ルート以下のすべてのドキュメントの情報が格納される場所です。この情報はクロスリファレンスを作成する際に利用されます。この環境には、パース段階の後の結果のpickleされたものが入ります。ソースファイルが新規で作成されたり、変更されて、読み込んだりパースしたりする必要がない限りはこの中のデータが更新されることはありません。ひとつのSphinxプロジェクトにおいて、すべてのソースファイルを含むディレクトリ。このディレクトリ直下だけではなく、サブディレクトリを使用してソースファイルを分類して入れておくことも可能です。いうフラッグを与えることができるようになりました。これを指定すると、自動的にエントリーをアルファベット順に並べることができます。productionを文法規則と意訳してます)形式がきちんとした文法の規則を表示するための特別なマークアップを利用することができます。マークアップはシンプルに作られています。その代わりに、BNFや、BNFの派生の記法をすべてのモデル化することは目標とされていませんが、文脈自由文法を表現するには十分な機能を持っていて、シンボルを書くと、定義にリンクが張られるようにレンダリングされます。productionlist::¶このディレクティブは文法の規則を表現するためのものです。それぞれの規則は一行で表現され、コロン(:)の前が名前で、その後ろが定義になります。定義を複数行で書くこともできますが、この場合は、それぞれの定義の行の先頭に、最初の行と同じ高さにそろえてコロン(:)を書く必要があります。中には空行を入れることはできません。定義には解釈済みのテキストとしてマークされたトークン名を含むことができます。これらのトークンの規則との間にクロスリファレンスが生成されます。いった文字をエスケープすることはできません。