reSTは “フィールドリスト”という考えがあります。以下のようなものが、このフィールドのマークアップのリストのサンプルになります。
ファイルの先頭のフィールドリストは “docinfo” としてパースされます。これは通常のドキュメントでは著者名や、公開日などのメタデータを記録するのに使用します。Sphinxでは、 docinfoはメタデータとして使用されますが、出力はされません。
このタイミングでは、以下のメタデータのフィールドが識別されています:
このファイルに表示する目次の最大の深さ
バージョン 0.4 で追加.
現在のセクションの著者名を指定します。引数には必ず、表示するための著者の名前と、電子メールのアドレスを入れます。アドレスのドメイン名の部分は小文字でなければなりません:
.. sectionauthor:: Guido van Rossum <guido@python.org>
デフォルトでは、このマークアップは出力に反映されません(貢献者の名前を調べる手助けにはなります)。しかし、設定ファイルの show_authors をTrueに設定すると、出力ファイルの中にこの情報に関する段落が作成されます。
<式> が真のときだけ、ディレクティブの内容をインクルードします。式は以下のようにタグで構成されます。
未定義のタグはflaseになります。コマンドラインの -t オプションもしくは conf.py によって定義されたタグはtrueとして扱われます。カッコも含めて、ブール演算も使用することができます。 html and (latex or draft) というような表現がサポートされています。
現在のビルダーのフォーマットのタグ (html, latex, text) は常にタグとしてセットされます。
バージョン 0.6 で追加.
標準のreStructuredTextの表を使用すると、HTML出力では非常にきれいな表を作成することができますが、LaTeXで出力すると、ちょっとがっかりしてしまうでしょう。現在の仕様ではカラムを自動で正しく決定するのは簡単ではありません。このような理由から、それをサポートするディレクティブがいくつか用意されています:
このディレクティブは次に作成するテーブルの “カラム仕様” を設定します。仕様はSphinxがテーブルの変換に使用している、LaTeXの tabulary パッケージ環境のためのものです。2番目の引数として設定します。以下のような値を設定します:
|l|l|l|
これは、３つの左寄せの、改行なしのカラムの意味になります。それぞれのカラムで、長いテキストを適切に自動的に改行させるためには、標準の p{width} 構造体を使用するか、tabularyの自動設定を使用します。
| L | 左寄せのカラム。長さは自動調整。 |
| R | 右寄せのカラム。長さは自動調整。 |
| C | 中央寄せのカラム。長さは自動調整。 |
| J | テキストを広げるカラム。長さは自動調整。 |
長さが自動調整となっているものは、全体の長さのうち、それぞれのカラムが占める幅の割合に応じて列の大きさはスケールします。
デフォルトでは、Sphinxはすべてのカラムに対して L を適用したレイアウトを自動で行います。
警告
リテラルブロックを含むテーブルには tabulary は適用できません。このような場合には、LaTeX標準の tabular 環境がしようされます。また、 p{width} を設定しないと、同様な環境は使用することはできません。デフォルトでは、というのは、Sphinxはそのようなテーブルのためには、そのようなカラムを生成します。 tabularcolums ディレクティブを使用することで、テーブルに対して細かい制御ができるようになります。