0. reStructuredText的基础使用
reStructuredText 是 Sphinx 默认使用的纯文本标记语言。这个部分简要介绍 reStructuredText(reST) 的概念和语法,目标是给文档创作者足够的知识,提高工作效率。由于 reST 设计目标本来就是简单的标记语言,学起来也不会很费力。
注解
一般来说通常使用比较多的是markdown,但是markdown在其标签多样性中表现并没有rst表现的好,一些需要注释或者说明的情况使用rst在展示中表现会更好。
References
- 1
reStructuredText 用户文档 http://docutils.sourceforge.net/rst.html
- 2
用 reStructuredText 写作:快速入门指南 http://www.bary.com/doc/a/228277572381775842/