reStructuredText
Sign in to savereStructuredText (RST, ReST, or reST) is a plain-text markup language primarily used for technical documentation and other textual data. It serves a similar role as Markdown but includes additional semantic features for more complex document structuring. Prominent, large-scale, open-source projects that rely on reStructuredText include the Python programming language community for its official documentation, the Linux kernel docs, CMake, and the LLVM compiler project.
Key facts
- File format.name
- reStructuredText
- File format.icon
- frameless|reStructuredText logo|class=skin-invert
- File format.extension
- .rst
- File format.owner
- David Goodger
- File format.latest release version
- Revision 8407
- File format.open
- Public domain
via Wikipedia infobox
Article
9 sectionsContents
- History
- Reference implementation
- Applications
- Examples
- Document Heading
- =
- See also
- References
- External links
reStructuredText (RST, ReST, or reST) is a plain-text markup language primarily used for technical documentation and other textual data. It serves a similar role as Markdown but includes additional semantic features for more complex document structuring. Prominent, large-scale, open-source projects that rely on reStructuredText include the Python programming language community for its official documentation, the Linux kernel docs, CMake, and the LLVM compiler project.
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 Plain Old Documentation (POD) for Perl. Docutils can extract comments and information from Python programs, and format them into various forms of program documentation.