フィールドリスト¶

As previously discussed フィールドリストは、以下のようにラベル付けされたフィールドシーケンスである。

:fieldname: Field content

Sphinxは、フィールドリストの標準docutilsアクションを拡張し、本節で紹介するいくつかの追加機能を追加します。

注釈

フィールドリストの値は文字列として解析される.リストや辞書のようなPythonセットを使用することはできません。

文書範囲のメタデータ¶

ファイルの上部付近のフィールドリストは、通常、docutilsによって解析される 文書情報. ページに表示されますしかしながら、Sphinxでは、任意の他のタグの前に位置するフィールドリストは、 文書情報. 文書メタデータとしてSphinx環境に送信され，出力には表示されない.

注釈

文書タイトルの後に表示されるフィールドリスト will 成る 文書情報. 正常に表示され、出力に表示される。

Sphinxは、Docutilsと比較して、書誌フィールドのカスタムアクションを提供する。

現在、以下のメタデータフィールドを識別することができる。

tocdepth

このファイルのディレクトリの最大深さ.**

:tocdepth: 2

注釈

このメタデータはローカルディレクトリ木の深さに影響を与える.しかしこれは…に影響を与えません深さです 全世界 三分木です。したがって、これはグローバルテーマを使用するいくつかのサイドバーを変えないだろう。

バージョン 0.4 で追加.

nocomments

設定すると，Webアプリケーションはこのソースファイルから生成されたページのコメントフォームを表示しない.**

:nocomments:

orphan

設定されている場合、このファイルがディレクトリツリーに含まれていないことに関する警告は表示されない。**

:orphan:

バージョン 1.0 で追加.

nosearch

設定されている場合は、このファイルの全文検索を無効にします。**

:nosearch:

注釈

以下の場合でも，対象検索は利用可能である nosearch オプションが設定されました。

バージョン 3.0 で追加.