reStructuredText

From Wikipedia, the free encyclopedia

reStructuredText is a lightweight markup language intended to be highly readable in source format. It's formal name uses unconventional typography, and is shown in documentation as “reStructuredText”, with the italics and code font that cannot be rendered correctly by the format. (Its documentation, which is otherwise stored in reST format, uses an embedded image to render the title with the preferred typography.)

reStructuredText is sometimes abbreviated as RST; while sometimes abbreviated as 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,[1] 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.

[edit] 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

Named links:

A sentence with links to Google_ and the `Linux kernel archive`_.

.. _Google: http://www.google.com/
.. _Linux kernel archive: http://www.kernel.org/

Anonymous links:

Another sentence with an `anonymous link to the Python website`__.

__ http://www.python.org/

[edit] See also

[edit] References and External links

  1. ^ Goodger, David; [1] (2006-09-22). reStructuredText: Markup Syntax and Parser Component of Docutils. Docutils Project. Retrieved on 2008-06-11.
Soft Eng logo This computer language-related article is a stub. You can help Wikipedia by expanding it.