reStructuredText 书目字段正确使用

Question

对于 python 文件使用 reStructuredText 书目字段的正确方法是什么？

Answer 1

如何使用此类字段的最突出的示例是在 Python PEP 中，例如PEP-0414：

PEP: 414
Title: Explicit Unicode Literal for Python 3.3
Version: $Revision$
Last-Modified: $Date$
Author: Armin Ronacher <[email protected]>,
        Nick Coghlan <[email protected]>
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Created: 15-Feb-2012
Post-History: 28-Feb-2012, 04-Mar-2012
Resolution: http://mail.python.org/pipermail/python-dev/2012-February/116995.html

虽然这是一个较长的字段列表，但它显示了它们的使用方式。

如其余文档中所述，

此书目数据对应于书籍的封面，例如标题页和版权页。

因此每个文档应该只有一组这样的字段，即在开头。不要忘记 reST 是作为 Python 文档的轻量级标记而开发的。

Answer 2

请注意，PEP 源接受特殊的语法变体。在标准 rST 中， 必须使用带有冒号的“字段列表”语法：

:Content-Type: text/x-rst
:Created: yesterday
:Abstract: This is just a silly example

请参阅 Docutils 文档 了解更多示例。 （另请检查每个文档页面上链接的 rST 源文件。）