diff options
| author | Georg Brandl <georg@python.org> | 2011-01-04 00:08:38 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-04 00:08:38 +0100 |
| commit | a484a62f11cbae549ef1b1956330ab1dc7c068d2 (patch) | |
| tree | 3f896da2ee7ada11411ee3b02f600fd49358978c /doc/markup | |
| parent | 0aa9538484f5c23bf6bad66042b65f99e48d6366 (diff) | |
| download | sphinx-git-a484a62f11cbae549ef1b1956330ab1dc7c068d2.tar.gz | |
#578: doc clarification.
Diffstat (limited to 'doc/markup')
| -rw-r--r-- | doc/markup/misc.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index b50fb8cae..39109a58c 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -13,10 +13,12 @@ like this:: :fieldname: Field content -A field list at the very top of a file is parsed by docutils as the "docinfo", +A field list near the top of a file is parsed by docutils as the "docinfo" which is normally used to record the author, date of publication and other -metadata. *In Sphinx*, the docinfo is used as metadata, too, but not displayed -in the output. +metadata. *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. At the moment, these metadata fields are recognized: |