reStructuredText 标识语法

3. reStructuredText 标识语法#

使用Shpinx编写文档有如下优点:

  • Sphinx支持 reST 和 MarkDown 语法,方便共享及开源编辑,使用git也方便跟踪。

  • 由于 reST 语法比 MarkDown 语法更强大和方便,更推荐使用 reST 语法编写文档, Linux内核源码文档也是使用 reST 格式编写的。

关于 reST 与 Markdown 语法方面的比较,这二者都是标识语言, 没有本质的差别; 从使用及阅读上也很难分出优劣。

现状是 Markdown 得到了更多的支持,工具更多,应用也更广泛。 但是 reST 在功能需求更多,更复杂方面的优势也毋庸置疑。

这里先介绍 reST ( reStructuredText ) ,其官方文档为 https://docutils.sourceforge.io