域清单

如前所述，字段列表是标记为这样的字段序列:

:fieldname: Field content

与docutils相比，Sphinx为书目字段提供自定义行为。

File-wide metadata

靠近文件顶部的字段列表通常由docutils解析为 docinfo ，它通常用于记录作者，发布日期和其他元数据。但是，在Sphinx中，任何其他标记之前的字段列表将作为文档元数据从 docinfo 移动到Sphinx环境，并且不会显示在输出中;文档标题后出现的字段列表将正常显示在 docinfo 中，并将显示在输出中。

目前，这些元数据字段被识别:

tocdepth

此文件的目录的最大深度。

:tocdepth: 2

0.4 新版功能.

nocomments

如果设置，Web应用程序将不会显示从此源文件生成的页面的注释表单。

:nocomments:

orphan

如果设置，将禁止有关此文件的警告未包含在任何toctree中。

:orphan:

1.0 新版功能.