reStructuredText

This project is now inactive. All development has been taken over by the Docutils project.

last updated: 2002-04-21

reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains. It is a candidate markup syntax for the Python Docstring Processing System. reStructuredText is a revision and reinterpretation of the StructuredText and Setext lightweight markup systems.

The primary goal of the reStructuredText project is to define and implement a markup syntax for use in Python docstrings and other documentation domains, that is readable and simple, yet powerful enough for non-trivial use. The intended purpose of the markup is the conversion of reStructuredText documents into useful structured data formats.

See statemachine.py for an example of a Python module fully documented using reStructuredText.

Project Status

This project is now inactive. All development has been taken over by the Docutils project.

This project consists of a Python package, “dps.parsers.restructuredtext”, a component of the Python Docstring Processing System (DPS). The reStructuredText parser is functionally complete.

CVS Snapshots

The final CVS snapshots are available below:

Project Releases

Development has been suspended at this site. All new development is taking place at the Docutils project.

The final project release package (restructuredtext-0.4.tar.gz) and past project releases can be downloaded from the project files page. The final DPS package (dps-0.4.tar.gz) is also required. Anonymous CVS access is available. You can also browse the latest reStructuredText source files (CVS) individually, and read the final README and HISTORY files.

User Documentation

The user documentation files are located in the docs directory of the latest project release package (which may not be up to date). The up-to-date working documents (from CVS) may be accessed individually below, or from the snapshots above. You can also browse the CVS repository directly.

Specification

All of the specification files are located in the spec directory of the latest project release package (which may not be up to date). The up-to-date working documents (from CVS) may be accessed individually below, or from the snapshots above. You can also browse the CVS repository directly.

You Can Help!

If you can test, administrate, or contribute code, ideas, bug reports, yummy treats, computer equipment, and/or large sums of money, please contact the project administrator.

Project Info