IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#578: doc clarification.

Browse Source
This commit is contained in:
Georg Brandl 2011-01-04 00:08:38 +01:00
parent 0aa9538484
commit a484a62f11
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/markup/misc.rst
View File

@ -13,10 +13,12 @@ like this::
:fieldname: Field content :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 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 metadata. *In Sphinx*, a field list preceding any other markup is moved from
in the output. 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: At the moment, these metadata fields are recognized: