译自http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
reStructuredText是纯文本格式,采用简单直观的结构表示结构化的文档。这些结构很容易阅读和处理。本篇文档本身就是reStructuredText例子。reStructureText解析器是Docutils的一个组件。
用简单,隐式的标记来表示特殊的结构,如节标题,无序列表和强调。使用的标记尽可能的简单和恰当。不经常使用的标记可能会比较复杂或有明确的标记。
reStructuredText既可以应用于篇幅较小的文档(如内联程序文档,如python文档),也可一个用于篇幅很长的文档(如本文)。
第一部分通过例子来展示一些reStructuredText基本语法,然后会给出详细的语法规范。
本篇文章通过文本块来展示示例。
内容
语法概览
语法详细
空白字符
空行
缩进
转义机制
引用名称
文档结构
文档
节
转换
主体元素
段落
无序列表
有序列表
定义列表
字段列表
书目字段
RCS关键字
选项列表
文本块
缩进文本块
引用文本块
行块
块引用
Doctest块
表格
网格表格
简单表格
显示标记块
脚注
自动编号脚注
自动符号脚注
手动和自动编号混合脚注
引文
链接目标
匿名链接
指令
替代定义
注释
隐士链接目标
内联标记
内联标记识别规则
识别顺序
字符级内联标记
强调
着重强调
解释文本
内联文本
超链接引用
嵌入式URI和别名
内联内部目标
脚注引用
引文引用
替代引用
标准超链接
单位
长度单位
百分比单位
错误处理
语法概述
reStructuredText文档由主体或块级元素构成,还可以结构化为节。节是根据标题样式(下划线和可选的上划线)决定的。节包含主体元素和/或子节。主体元素包含更多的元素,如列表项,段落和其他主体元素。其他的,例如段落包含文本和内联标记元素。
下面是一些主体元素示例:…