ReStructuredText

历史

早期的轻量级标记语言StructuredText（由 Zope 开发）存在许多问题，reST 就是为了解决这些问题而开发的。选择了reStructuredText 这个名称是为了表明reST 是一个“经过修改、重写和重新解释的结构化文本”。
reST 在 2002 年开始在Python 社区中得到了重要的应用。

参考实现

reST 解析器的引用实现是Python 编程语言中的Docutils 文本处理框架的一个组件，但是还可以使用其他解析器。
没有正式的mime 类型注册为reStructuredText，但非官方的是``text/x-rst``。

应用程序

reStructuredText 通常用于技术文档，例如 Python 库的文档。然而，它也适用于广泛的文本。
自 2008 年以来，reST 一直是Python 的 Sphinx 文档生成系统的核心组件。
Trac 也支持reStructuredText，GitHub 和 Bitbucket 也是如此。
为古登堡计划准备文本的分布式校对器正在考虑采用reST 作为一种基本格式，其他电子书格式可以从这种格式生成。
2016 年 7 月，Linux 内核项目决定从基于DocBook 的文档过渡到reStructuredText 和 Sphinx 工具链。
在 3.0 版本中，软件构建工具CMake 从自定义标记语言转换为reStructuredText。

标题

节标题==============

小节标题------------------

列表

- A bullet list item
- Second item

  - A sub item

- Spacing between items creates separate lists

- Third item

1) An enumerated list item

2) Second item

   a) Sub item that goes on at length and thus needs
      to be wrapped. Note the indentation that must
      match the beginning of the text, not the 
      enumerator.

      i) List items can even include

         paragraph breaks.

3) Third item

#) Another enumerated list item

#) Second item

图片

.. image:: /path/to/image.jpg

指定链接

A sentence with links to `Wikipedia`_ and the `Linux kernel archive`_.

.. _Wikipedia: https://www.wikipedia.org/
.. _Linux kernel archive: https://www.kernel.org/

匿名链接

Another sentence with an `anonymous link to the Python website`__.

__ https://www.python.org/
N.B.: 指定链接和匿名链接用重字符(`)括起来，而不是用引号(')括起来。

文字块

::  some literal text

This may also be used inline at the end of a paragraph, like so::  some more literal text.. code:: python

   print("A literal block directive explicitly marked as python code")