python - reStructuredText 书目字段正确使用

Question

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

Answer 1

The most prominent example of how to use such fields is in the Python PEPs, e.g. PEP-0414:

PEP: 414
Title: Explicit Unicode Literal for Python 3.3
Version: $Revision$
Last-Modified: $Date$
Author: Armin Ronacher <armin.ronacher@active-4.com>,
        Nick Coghlan <ncoghlan@gmail.com>
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

While this is a longish list of fields, it shows how they are used.

As explained in the reST documentation,

This bibliographic data corresponds to the front matter of a book, such as the title page and copyright page.

so there should be only one set of such fields per document, namely at the beginning. Don't forget that reST was developed as a lightweight markup for Python documentation.