reStructuredText 语法¶
RST 语法¶
reStructuredText 是扩展名为 .rst 的纯文本文件，含义为”重新构建的文本”，也被简称为：RST 或 reST；是 Python 编程语言的 Docutils 项目的一部分，Python Doc-SIG (Documentation Special Interest Group)。该项目类似于 Java 的 JavaDoc 或 Perl 的 POD 项目。 Docutils 能够从 Python 程序中提取注释和信息，格式化成程序文档。
.rst 文件是轻量级标记语言的一种，被设计为容易阅读和编写的纯文本，并且可以借助 Docutils 这样的程序进行文档处理，也可以转换为 HTML 或 PDF 等多种格式，或由 Sphinx-Doc 这样的程序转换为 LaTex、man 等更多格式。
本文语法来自 Quick reStructuredText。
内容参考了 seayxu reStructuredText(rst)快速入门语法说明 、 赵子清 使用Sphinx + reST编写文档 、 Sphinx 使用手册 、Sphinx与reStructuredText 。
你可以在这里下载本文档的。全部源码。
修订日志¶
2017-12-02 |
初版 |
2018-03-26 |
1.1 版 |
2019-05-08 |
2.0 版，增加载入外部文件 和 转义、页面文件拆分 |
2019-06-25 |
2.0.1 版，增加引入资源文件 |
2020-11-19 |
2.0.2 版，增加其他语言代码展示、锚点修复、增加各类型提示 |