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

Review markup chapter.

Browse Source
This commit is contained in:
Georg Brandl
2010-03-01 14:37:31 +01:00
parent 0f812e72f7
commit 3e9182550a
2 changed files with 36 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/markup/misc.rst
View File

@@ -11,12 +11,12 @@ File-wide metadata
reST has the concept of "field lists"; these are a sequence of fields marked up
like this::
:Field name: Field content
:fieldname: Field content
A field list at the very top of a file is parsed as the "docinfo", which in
normal documents can be 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.
A field list at the very 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.
At the moment, these metadata fields are recognized: