python - 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 <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

これは長いフィールドのリストですが、それらがどのように使用されるかを示しています。

reSTドキュメントで説明されているように、

この書誌データは、タイトルページや著作権ページなどの本の前書きに対応しています。

したがって、ドキュメントごとに、つまり最初に、そのようなフィールドのセットは1つだけにする必要があります。reSTはPythonドキュメントの軽量マークアップとして開発されたことを忘れないでください。