Field Lists

As previously discussed, field lists are sequences of fields marked up like this:

:fieldname: Field content

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.

Special metadata fields

Sphinx provides custom behavior for bibliographic fields compared to docutils.

このタイミングでは、以下のメタデータのフィールドが識別されています:

tocdepth

The maximum depth for a table of contents of this file.

:tocdepth: 2

注釈

This metadata effects to the depth of local toctree. But it does not effect to the depth of global toctree. So this would not be change the sidebar of some themes which uses global one.

バージョン 0.4 で追加.

nocomments

If set, the web application won't display a comment form for a page generated from this source file.

:nocomments:
orphan

If set, warnings about this file not being included in any toctree will be suppressed.

:orphan:

バージョン 1.0 で追加.

nosearch

If set, full text search for this file is disabled.

:nosearch:

注釈

object search is still available even if nosearch option is set.

バージョン 3.0 で追加.