reStructuredText ( RST 、 ReST 或 reST )是一种用于文本数据的文件格式,主要用于 Python 编程语言社区的技术文档。html
它是Python Doc-SIG(Documentation Special Interest Group)的 Docutils 项目的一部分,旨在为 Python 建立一组相似于 Java 的 Javadoc 或 Perl 的 Plain Old Documentation(pod)的工具。Docutils 能够从 Python 程序中提取注释和信息,并将它们格式化为各类形式的程序文档。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.htmlide
目前还有一个在线的编辑环境,请参考 http://rst.ninjs.org/#Kml0YWxpY3Mq 上面的内。工具
你能够在上面的连接中对标记文件进行编辑。ui
在编辑的过程当中,你可能还须要对 Markup 的语法有所了解。设计