reStructuredText ( RST 、 ReST 或 reST )是一种用于文本数据的文件格式,主要用于 Python 编程语言社区的技术文档。
它是Python Doc-SIG(Documentation Special Interest Group)的 Docutils 项目的一部分,旨在为 Python 创建一组类似于 Java 的 Javadoc 或 Perl 的 Plain Old Documentation(pod)的工具。Docutils 可以从 Python 程序中提取注释和信息,并将它们格式化为各种形式的程序文档。
从这个意义上说,reStructuredText 是一种轻量级标记语言,其设计目的是(a)文档处理软件(如Docutils)可以处理它,(b)读和写 Python 源代码的程序员很容易读它。
reST 解析器的引用实现是 Python 编程语言中的 Docutils 文本处理框架的一个组件,但是还可以使用其他解析器。
没有正式的 mime 类型注册为 reStructuredText,但非官方的是text/x-rst
可以将 RST 文件理解为 Python 使用的 Markup 文件就可以了。
官方的使用手册,请参考链接:https://docutils.sourceforge.io/docs/user/rst/quickstart.html
目前还有一个在线的编辑环境,请参考 http://rst.ninjs.org/#Kml0YWxpY3Mq 上面的内。
你可以在上面的链接中对标记文件进行编辑。
在编辑的过程中,你可能还需要对 Markup 的语法有所了解。