字段列表¶

如先前討論，字段列表是像這樣標記的字段序列

:fieldname: Field content

Sphinx 擴展了標準 docutils 對於字段列表的行為，並添加了一些額外功能，將在本節中介紹。

注意

字段列表的值將被解析為字串。您不能使用 Python 集合，例如列表或字典。

檔案範圍中繼資料¶

檔案頂部附近的字段列表通常被 docutils 解析為 *docinfo* 並顯示在頁面上。然而，在 Sphinx 中，任何其他標記之前的字段列表會從 *docinfo* 移動到 Sphinx 環境作為文件元數據，並且不會在輸出中顯示。

注意

出現在文件標題之後的字段列表 *將會* 像往常一樣成為 *docinfo* 的一部分，並將在輸出中顯示。

相較於 docutils，Sphinx 為書目字段提供了自訂行為。

目前，這些中繼資料字段被識別

tocdepth

此檔案的目錄的最大深度。

:tocdepth: 2

注意

此中繼資料會影響本地目錄樹的深度。但它不影響 *全域* 目錄樹的深度。因此，這不會更改使用全域目錄樹的主題側邊欄。

在版本 0.4 中新增。

nocomments

如果設定，Web 應用程式將不會為由此源檔案產生的頁面顯示評論表單。

:nocomments:

orphan

如果設定，將會抑制關於此檔案未包含在任何目錄樹中的警告。

:orphan:

在版本 1.0 中新增。

no-search

停用此文件的全文搜尋。

:no-search:

注意

:no-search: 選項僅停用全文搜尋，這表示即使設定了 :no-search:，物件搜尋仍然可用。

在版本 3.0 中新增。

在版本 7.3 中變更：檔案範圍中繼資料選項 :nosearch: 已重新命名為 :no-search:。先前的名稱已保留為別名，但將在未來版本的 Sphinx 中棄用並移除。