字段列表¶

如前所述，字段列表是标记如下的一系列字段

:fieldname: Field content

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

注意

字段列表的值将被解析为字符串。你无法使用 Python 集合，例如列表或字典。

文件级元数据¶

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

注意

出现在文档标题后的字段列表将是docinfo的一部分，如常显示在输出中。

与 docutils 相比，Sphinx 为参考文献字段提供了自定义行为。

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

tocdepth

此文件目录的深度上限。

:tocdepth: 2

注意

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

添加于版本 0.4。

nocomments

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

:nocomments:

orphan

如果设置，将抑制关于该文件未包含在任何 toctree 中的警告。

:orphan:

添加于版本 1.0。

nosearch

如果设置，将禁用对该文件的全文搜索。

:nosearch:

注意

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

添加于版本 3.0。