字段列表¶

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

: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版本中弃用并删除。