Question

将reStructuredText Bibliographic fields用于python文件的正确方法是什么？

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文档中所述，

此书目数据对应于书籍的前沿事项，例如标题页和版权页。

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

reStructuredText书目字段正确使用

1 个答案: