docutils-develop — For developer discussions of the implementation.

[David G. <go...@us...>]

The purpose of the Docutils project is to create a set of tools for
processing plaintext documentation into useful formats, such as HTML,
XML, and TeX.  It is the subject of PEPs 256 & 258.  Docutils
currently supports input from standalone files; soon it will process
PEPs, and eventually it will support inline documentation from Python
modules and packages.  Docutils uses the reStructuredText markup, the
subject of PEP 287; other markups are possible.  It produces simple
HTML for CSS; other formats will become available in time.

Quick link to the download:

    http://prdownloads.sf.net/docutils/docutils-0.1.tar.gz

Docutils home page: http://docutils.sourceforge.net/

To subscribe to the mailing lists:

- Development discussions (doc...@li...):
  http://lists.sourceforge.net/lists/listinfo/docutils-develop

- CVS checkin messages:
  http://lists.sourceforge.net/lists/listinfo/docutils-checkins

High-level discussions take place on the Python Doc-SIG mailing list:
http://mail.python.org/mailman/listinfo/doc-sig,
mailto:Do...@py...

A ReStructuredText Primer (gentle introduction):
http://docutils.sf.net/docs/rst/quickstart.html

Quick reStructuredText (user reference):
http://docutils.sf.net/docs/rst/quickref.html

There has been a lot of progress lately.  The reStructuredText parser
is feature-complete, there's a standalone input file reader, and a
simple HTML/CSS writer.  The web site's HTML files are generated from
reStructuredText source (the quickref being the only exception).
There are a few simple front-ends in docutils/tools; see the README:
http://docutils.sf.net/README.html.

There is still much work to be done.  Contributors are welcome!


Release 0.1 (2002-04-20)
========================

This is the first release of Docutils, merged from the now inactive
reStructuredText_ and `Docstring Processing System`_ projects.  For
the pre-Docutils history, see the `reStructuredText HISTORY`_ and
`DPS HISTORY`_ files.

.. _reStructuredText: http://structuredtext.sf.net/
.. _Docstring Processing System: http://docstring.sf.net/
.. _reStructuredText HISTORY:
   http://structuredtext.sf.net/HISTORY.html
.. _DPS HISTORY: http://docstring.sf.net/HISTORY.html

General changes: renamed 'dps' package to 'docutils'; renamed
'restructuredtext' subpackage to 'rst'; merged the codebases; merged
the test suites (reStructuredText's test/test_states renamed to
test/test_rst); and many modifications required to make it all work.

-- 
David Goodger  <go...@us...>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
  - The Go Tools Project: http://gotools.sourceforge.net/