字段列表¶

如前所述 ,字段列表是按如下方式标记的字段序列:

:fieldname: Field content

Sphinx 扩展了标准 docutils 对字段列表的行为,并在本节中涵盖了一些额外的功能.

备注

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

文件级元数据¶

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

备注

文档标题后的字段列表将作为常规的一部分包含在 docinfo 中,并将在输出中显示.

Sphinx 为文献字段提供了与 docutils 不同的自定义行为.

目前,已识别以下元数据字段:

tocdepth

此文件目录的最大深度.:

:tocdepth: 2

备注

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

Added in version 0.4.

nocomments

如果设置,则该网页应用将不会为从此源文件生成的页面显示评论表单.:

:nocomments:

orphan

如果设置,将抑制关于此文件未包含在任何 toctree 中的警告.:

:orphan:

Added in version 1.0.

nosearch

如果设置,则此文件的全文搜索将被禁用.:

:nosearch:

备注

对象搜索依然可用,即使设置了 nosearch 选项.

Added in version 3.0.