フィールドリスト¶

以前議論したとおり、フィールドリストはこのようにマークアップされたフィールドのシーケンスト

:fieldname: Field content

Sphinx はフィールドリストの標準ドキュメントユーティリティの動作を拡張し、このセクションで説明する追加機能を追加します。

注

フィールドリストの値は、文字列として解析されます。リストやディクショナリなどの Python コレクションは使用できません。

ファイル全体メタデータ¶

ファイルの先頭付近のフィールドリストは通常、ドキュメントユーティリティで docinfo として解析され、ページに表示されます。ただし、Sphinx では、他のマークアップより前にあるフィールドリストは、docinfo から Sphinx 環境にドキュメントメタデータとして移動され、出力には表示されません。

注

ドキュメントタイトルの後に表示されるフィールドリストは、通常どおり docinfo の一部となり、出力に表示されます。

特製のメタデータフィールド¶

Sphinx は、ドキュメントユーティリティと比較して、書誌フィールドに対してカスタム動作を提供します。

現時点では、次のメタデータフィールドが認識されています

tocdepth

このファイルの目次に対する最大の奥行き。

:tocdepth: 2

注

このメタデータは、ローカルの toctree の奥行きに影響を与えます。ただし、全体 toctree の奥行きには影響を与えません。つまり、全体 toctree を使用しているテーマのサイドバーは変更されません。

バージョン 0.4 で追加されました。

nocomments

設定されている場合、Web アプリケーションは、このソースファイルから生成されたページのコメントフォームを表示しません。

:nocomments:

orphan

設定されている場合、このファイルが toctree に含まれていないという警告が抑制されます。

:orphan:

バージョン 1.0 で追加されました。

nosearch

設定されている場合、このファイルの全文検索が無効になります。

:nosearch:

注

nosearch オプションが設定されている場合でも、オブジェクト検索は使用できます。

バージョン 3.0 で追加されました。