ReStructuredText
Encyclopedia
reStructuredText is a lightweight markup language
intended to be highly readable in source
format. Its formal name indicates that it is a "revised, reworked, and reinterpreted StructuredText."
reStructuredText is sometimes abbreviated as RST; while sometimes abbreviated as ReST or reST, this can create confusion with REST
, an unrelated technology.
The reference parser is implemented as a component of the Docutils text processing framework in the Python programming language
, but other parsers are available. It was a re-implementation and extension of the StructuredText and Setext
lightweight markup systems, and was meant in particular to address the Problems with StructuredText.
reStructuredText is commonly used for technical documentation, for example, in documentation of Python libraries. However, reStructuredText is suitable for a wide range of texts.
Distributed Proofreaders
, which prepares texts for Project Gutenberg
, is considering adoption of reStructuredText as a basic format from which other ebook formats could be generated.
Section Header
Subsection Header
-----------------
Lists:
- A bullet list item
- Second item
- A sub item
- Third item
1) An enumerated list item
2) Second item
a) Sub item
i) Sub-sub item
3) Third item
#) Another enumerated list item
#) Second item
Images:
.. image:: /path/to/image.jpg
Named links:
A sentence with links to Wikipedia_ and the `Linux kernel archive`_.
.. _Wikipedia: http://www.wikipedia.org/
.. _Linux kernel archive: http://www.kernel.org/
Anonymous links:
Another sentence with an `anonymous link to the Python website`__.
__ http://www.python.org/
Named links and Anonymous links enclose text in grave accents (`), and not in apostrophes (').
External links
Lightweight markup language
A lightweight markup language is a markup language with a simple syntax, designed to be easy for a human to enter with a simple text editor, and easy to read in its raw form....
intended to be highly readable in source
Source code
In computer science, source code is text written using the format and syntax of the programming language that it is being written in. Such a language is specially designed to facilitate the work of computer programmers, who specify the actions to be performed by a computer mostly by writing source...
format. Its formal name indicates that it is a "revised, reworked, and reinterpreted StructuredText."
reStructuredText is sometimes abbreviated as RST; while sometimes abbreviated as ReST or reST, this can create confusion with REST
Representational State Transfer
Representational state transfer is a style of software architecture for distributed hypermedia systems such as the World Wide Web. The term representational state transfer was introduced and defined in 2000 by Roy Fielding in his doctoral dissertation...
, an unrelated technology.
The reference parser is implemented as a component of the Docutils text processing framework in the Python programming language
Python (programming language)
Python is a general-purpose, high-level programming language whose design philosophy emphasizes code readability. Python claims to "[combine] remarkable power with very clear syntax", and its standard library is large and comprehensive...
, but other parsers are available. It was a re-implementation and extension of the StructuredText and Setext
Setext
Setext is a lightweight markup language used to format plain text documents such as e-newsletters, Usenet postings, and e-mails. In contrast to some other markup languages , the text is easily readable without any parsing or special software....
lightweight markup systems, and was meant in particular to address the Problems with StructuredText.
reStructuredText is commonly used for technical documentation, for example, in documentation of Python libraries. However, reStructuredText is suitable for a wide range of texts.
Distributed Proofreaders
Distributed Proofreaders
Distributed Proofreaders is a web-based project that supports the development of e-texts for Project Gutenberg by allowing many people to work together in proofreading drafts of e-texts for errors.- History :...
, which prepares texts for Project Gutenberg
Project Gutenberg
Project Gutenberg is a volunteer effort to digitize and archive cultural works, to "encourage the creation and distribution of eBooks". Founded in 1971 by Michael S. Hart, it is the oldest digital library. Most of the items in its collection are the full texts of public domain books...
, is considering adoption of reStructuredText as a basic format from which other ebook formats could be generated.
Examples of markup
Headers:Section Header
Subsection Header
-----------------
Lists:
- A bullet list item
- Second item
- A sub item
- Third item
1) An enumerated list item
2) Second item
a) Sub item
i) Sub-sub item
3) Third item
#) Another enumerated list item
#) Second item
Images:
.. image:: /path/to/image.jpg
Named links:
A sentence with links to Wikipedia_ and the `Linux kernel archive`_.
.. _Wikipedia: http://www.wikipedia.org/
.. _Linux kernel archive: http://www.kernel.org/
Anonymous links:
Another sentence with an `anonymous link to the Python website`__.
__ http://www.python.org/
Named links and Anonymous links enclose text in grave accents (`), and not in apostrophes (').
External links
- reStructuredText reference pages
- An Introduction to ReStructuredText
- XML Matters: reStructuredText
- rst2a - reStructuredText to Anything - online reStructuredText-to-HTML and reStructuredText-to-PDF converter
- http://stackoverflow.com/questions/2746692/restructuredtext-tool-support - Tool support collection
- reStructuredText Support in Trac
- Support reStructuredText markup on gitHub
- Displaying README Text on your Bitbucket Source Tab