字段列表

As previously discussed ，字段列表是按如下方式标记的字段序列：

:fieldname: Field content

Sphinx扩展了字段列表的标准docutils行为，并添加了本节中介绍的一些额外功能。

备注

字段列表的值将被解析为字符串。不能使用Python集合，如列表或字典。

文件范围的元数据

文件顶部附近的字段列表通常由docutils解析为 文档信息 并显示在页面上。但是，在Sphinx中，任何其他标记前面的字段列表都会从 文档信息 作为文档元数据传递到Sphinx环境中，并且不显示在输出中。

备注

出现在文档标题后面的字段列表 will 成为 文档信息 正常并将显示在输出中。

特殊元数据字段

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

目前，可以识别这些元数据字段：

tocdepth

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

:tocdepth: 2

备注

此元数据影响本地目录树的深度。但它不会影响 全球的 托特瑞。因此，这不会改变一些主题的侧边栏使用全球一。

Added in version 0.4.

nocomments

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

:nocomments:

orphan

如果设置了该选项，则不会显示有关该文件未包含在任何目录树中的警告。：：

:orphan:

Added in version 1.0.

nosearch

如果设置，则禁用对此文件的全文搜索。:

:nosearch:

备注

对象搜索仍然可用，即使 nosearch 选项已设置。

Added in version 3.0.