reStructuredText 文献字段的正确用法

Question

在Python文件中，如何正确使用reStructuredText的参考文献字段？

Answer 1

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

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

有关更多示例，请查看Docutils文档。（还可以查看每个文档页面上链接的rST源文件。）

Answer 2

一个很明显的例子就是在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 文献字段的正确用法

2 个回答

撰写回答