字段列表¶

如前所述，字段列表是字段标记如下：

：字段名：字段内容

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

注意

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

文件范围元数据¶

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

注意

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

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

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

tocdepth（深度）

此文件目录的最大深度。

：to深度：2

注意

此元数据影响本地目录树的深度。但事实并非如此影响的深度全球的目录树。所以这并没有改变使用全局目录树的主题侧栏。

在版本0.4中添加。

没有意见

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

：no注释：

孤儿

如果设置了此选项，将显示有关此文件未包含在任何目录树中的警告抑制。

：孤儿：

在版本1.0中添加。

鼻拱

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

：鼻弓：

注意

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

在版本3.0中添加。