ANN: Docutils 0.2 Released

David Goodger goodger at users.sourceforge.net
Fri Aug 2 04:48:47 CEST 2002


[Resending; first time didn't get through.]

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 and PEPs; the emphasis
for release 0.3 will be support for inline documentation from Python
modules and packages.  Docutils uses the reStructuredText markup, the
subject of PEP 287; but other markups are possible.  It currently
produces simple HTML for CSS and Docutils-native XML.  PDF and DocBook
XML are under development, and other formats will become available in
time.

Quick link to the download:

    http://prdownloads.sourceforge.net/docutils/docutils-0.2.tar.gz

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

There have been many improvements since release 0.1:

* The front-end tools have increased in number and now have support
  for command-line options (thanks to Greg Ward's Optik) and
  configuration files.

* Added PEP processing (see http://docutils.sf.net/spec/pep-0287.html
  for an example).  Under consideration by PythonLabs and Python-Dev
  for python.org use.

* Added a new "simple tables" construct to reStructuredText.

* Improved the generated HTML.  Now XHTML-compatible.  Improved
  stylesheet support

* Unicode and input/output encoding support.

* Swedish and German output support (boilerplate translations; thanks
  to Adam Chodorowski and Gunnar Schwant).

* Lots of internal improvements.

To subscribe to the mailing lists:

* Development discussions (docutils-develop at lists.sourceforge.net):
  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:Doc-SIG at python.org

User documentation:

* 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

* Docutils Front-End Tools: http://docutils.sf.net/docs/tools.html

Further details here:

* Docutils README: http://docutils.sf.net/README.html

* Docutils History: http://docutils.sf.net/HISTORY.html

* Copying Docutils: http://docutils.sf.net/COPYING.html

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

-- 
David Goodger  <goodger at users.sourceforge.net>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
    (includes reStructuredText: http://docutils.sf.net/rst.html)
  - The Go Tools Project: http://gotools.sourceforge.net/




More information about the Python-list mailing list