网页
综合
更新时间 2026-11-17 02:35:45
Field Lists — Sphinx documentation
自动蜘蛛
www.sphinx-doc.org
正文约 1735 字
As previously discussed, field lists are sequences of fields marked up like this:
Sphinx extends standard docutils behavior for field lists and adds some extra functionality that is covered in this section.
The values of field lists will be parsed as strings. You cannot use Python collections such as lists or dictionaries.
A field list near the top of a file is normally parsed by docutils as the docinfo and shown on the page. However, in Sphinx, a field list preceding any other markup is moved from the docinfo to the Sphinx environment as document metadata, and is not displayed in the output.
A field list appearing after the document title will be part of the docinfo as normal and will be displayed in the output.
Sphinx provides custom behavior for bibliographic fields compared to docutils.
At the moment, these metadata fields are recognized:
The maximum depth for a table of contents of this file.
This metadata affects the depth of the local toctree. But it does not affect the depth of the global toctree. So this does not change the sidebar of themes that use the global toctree.
Added in version 0.4.
If set, the web application won’t display a comment form for a page generated from this source file.
If set, warnings about this file not being included in any toctree will be suppressed.
Added in version 1.0.
Disable full text search for this document.
The :no-search: option only disables full text search, meaning that object search will still be available even if :no-search: is set.
Added in version 3.0.
Changed in version 7.3: The file-wide metadata option :nosearch: was renamed to :no-search:. The previous name has been retained as an alias, but will be deprecated and removed in a future version of Sphinx.
本页为82搜索生成的网页快照,内容来自站内索引;演示数据的原文链接仅作示例。