README: The Sandbox

The Sandbox is a place to play around, to try out and share ideas. The sandbox/ directory is a part of the Subversion repository but it isn't distributed as part of Docutils releases.

It's OK to make a mess in the Sandbox! But please, play nice.

A project-specific subdirectory should be created for each new project. Any developer who wants to play in the sandbox may create their own subdirectory (suggested name: SourceForge ID, or given name + family initial), but project directories are recommended over personal directories, which discourage collaboration.

For more information, please see the Docutils Project Policies. The Sandbox is mirrored at the Docutils web site, so the Docutils Web Site documentation applies as well.

Sandbox Projects

Project Infrastructure

docutils-update is a script that is installed as a cron job on BerliOS.de to automatically update the Docutils web site whenever the SVN files change. Any .html document with a corresponding .txt file is regenerated whenever the .txt file changes.

Documenting Python

Some work has been done on enabling Docutils to write the "Documenting Python" variant of LaTeX, which we're calling "DocPy".

Since Python 2.6, the markup used for the official Python documentation is reStructuredText, amended by custom directives. The Sphinx toolset is used to generate the HTML and LaTeX versions.

Other Sandbox Projects

See the sandbox/ directory for a complete list.

  • Many Sandbox projects, are sorted into the Docutils Link List.
  • code-block-directive contains documentation, reasoning and experimental code for support of syntax highlight in docutils.
  • latex-variants is a place to try out and discuss improvements, fixes and variants of the latex2e writer.
  • LaTeX math for reST by Jens J. Mortensen writes Math to LaTeX or MathML.