ReStructuredText 快速教程

前言

这本书专注于 ReStructuredText 格式的最常用用法，以便读者能以最快时间掌握。

说明

全书分为三个部分：

  • 第一部分为基础语法篇，主要介绍 rst 文本的标题、段落、列表、块等；
  • 第二部分为进阶语法篇，主要介绍 rst 文本的表格、水平线、引用、超链接、图片、注释、代码块等；
  • 第三部分是Sphinx标记结构篇，主要介绍 rst 文本的标记结构如何使用。

同时，这个教程也可当作 rst 文本的语法手册查询，使用左边栏的目录和搜索栏可以很方便的查阅。

写作工具

本书使用的reStructuredText标记语言，相对Markdown来说，在写书方面更有优势:

  • 使用sphnix能够自动生成目录和索引文件，方便查询和检索；
  • 有大量漂亮的HTML书籍主题模版，可为书籍轻松换肤（类似Wordpress的网站模版）；
  • 对于参考手册类书籍的编写在语法上更为便利（python官方帮助文档的使用者）；

版权声明

注解

本书为开源图书，版权归作者所有；欢迎下载及编辑(个人用途)，但未经作者同意必须保留此段声明，且不可用于商业用途，否则保留追究法律责任的权利。