字段列表¶

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

:fieldname: Field content

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

备注

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

文件范围的元数据¶

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

备注

文档标题后显示的字段列表 will 成为这个世界的一部分 docinfo 正常显示，并将显示在输出中。

与Docutils相比，Sphinx提供了书目字段的定制行为。

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

tocdepth

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

:tocdepth: 2

备注

此元数据影响本地toctree的深度。但这并不影响深度 global 托特里。因此，这不会改变使用全局toctree的主题的侧边栏。

Added in version 0.4.

nocomments

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

:nocomments:

orphan

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

:orphan:

Added in version 1.0.

no-search

禁用此文档的全文搜索。

:no-search:

备注

的 :no-search: 选项仅禁用全文搜索，这意味着即使 :no-search: 已设置。

Added in version 3.0.

在 7.3 版本发生变更: 文件范围的元数据选项 :nosearch: 更名为 :no-search: .以前的名称已作为别名保留，但在Sphinx的未来版本中将被弃用并删除。