Docutils: Documentation Utilities

Written in Python, for General- and Special-Purpose Use

Docutils is an open-source text processing system for processing plaintext documentation into useful formats, such as HTML or LaTeX. It includes reStructuredText, the easy to read, easy to use, what-you-see-is-what-you-get plaintext markup language.

Overview

To get up & running quickly, see the Quick-Start section of the README file.

All documentation can be reached from the Docutils Project Documentation Overview.

To the developers of an open source project, feedback is a great motivator and is very welcome. We also rely on feedback for determining what features to implement. Thus, if you tell us what you need, you may just get it! Please post any feedback to the Docutils-users mailing list.

All discussion about Docutils takes place on the mailing lists.

If you find a bug, please file a bug report or send email to the Docutils-users mailing list. Patch submissions should be filed in the patch tracker or sent to Docutils-develop.

We welcome all kinds of contributions. There's a To Do list full of interesting ideas awaiting a champion. If you have any questions regarding how to extend Docutils, please feel free to ask on the Docutils-develop mailing list. Please also consider donating to Docutils: .

The only requirement for running Docutils is Python 2.2 or later. (Up to docutils-0.4 Python 2.1 may be used providing the compiler package is installed. The compiler package can be found in the Tools/ directory of Python's source distribution.)

Docutils is in active development and should be considered experimental. APIs are subject to change at any time.

Download

We recommend that you use the latest snapshot, docutils-snapshot.tgz. The snapshots usually contain more features and fewer bugs than the "official" releases—they're not only for developers!

The latest release package is docutils-0.5.tgz. It was released on 2008-06-25 and is mostly intended for distributors. See the release notes for a list of changes since the previous release (0.4).

More snapshots:

Snapshot of the Sandbox (experimental, contributed code; see the Sandbox for details)
Snapshot of DocFactory project files (this is a subset of the Sandbox snapshot above; you don't need both)

You can also access Docutils' Subversion repository directly.

Web site, tracker and mailing lists hosted by . Subversion repository hosted by . Powered by .