Filename extension .rst Open format? Public domain | Developed by David Goodger | |
Initial release April 2, 2002; 14 years ago (2002-04-02) Latest release Revision 7942
(May 25, 2016; 9 months ago (2016-05-25)) Website docutils.sourceforge.net/docs/ref/rst/restructuredtext.html | ||
reStructuredText (sometimes abbreviated as RST, ReST, or reST) is a file format for textual data used primarily in the Python programming language community for technical documentation.
Contents
It is part of the Docutils project of the Python Doc-SIG (Documentation Special Interest Group), aimed at creating a set of tools for Python similar to Javadoc for Java or POD for Perl. Docutils can extract comments and information from Python programs, and format them into various forms of program documentation.
In this sense, reStructuredText is a lightweight markup language designed to be both (a) processable by documentation-processing software such as Docutils, and (b) easily readable by human programmers who are reading and writing Python source code.
History
Setext (developed by Ian Feldman or Tony Sanders) and StructuredText (developed by Zope) were ancestral forms of lightweight markup language.
There were a number of problems with StructuredText, and reST was developed to address them. The name reStructuredText was chosen to indicate that reST is a "revised, reworked, and reinterpreted StructuredText."
reST began to see significant use in the Python community in 2002.
Applications
reStructuredText is commonly used for technical documentation, for example, in documentation of Python libraries. However, it is suitable for a wide range of texts.
Since 2008, reST has been a core component of Python's Sphinx document generation system.
Trac also supports reStructuredText, as do GitHub and Bitbucket.
Distributed Proofreaders, which prepares texts for Project Gutenberg, is considering adoption of reST as a basic format from which other ebook formats could be generated.
In July 2016 the Linux kernel project decided to transition from DocBook based documentation to reStructuredText and the Sphinx toolchain.
The software build tool CMake switched from a custom markup language to reStructuredText in version 3.0 for its documentation.
Headers
Section Header ============== Subsection Header -----------------Anonymous links
N.B.: named links and anonymous links are enclosed in grave accents (`), and not in apostrophes (').