Docutils: Documentation Utilities / Code
/ [r10125] /trunk/sandbox ([original](https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox)) ([raw](?raw))Tree [r10125] /trunk /sandbox / History
Read Me
.. -- rst-mode --
===================== 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 Docutils Subversion repository_
but it isn't distributed as part of Docutils_ releases.
To get a snapshot of the sandbox/ directory, go to
https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
and click the "Download Snapshot" button.
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.
.. These links give readers a way to go to the sandbox: .. _sandbox: .. _sandbox/: ./
.. _Docutils: https://docutils.sourceforge.io/ .. _Docutils Subversion repository: https://docutils.sourceforge.io/docs/dev/repository.html .. _Docutils Project Policies: https://docutils.sourceforge.io/docs/dev/policies.html#the-sandbox .. _Docutils Web Site: https://docutils.sourceforge.io/docs/dev/website.html
Sandbox Projects
See the sandbox/_ directory for a complete list.
Some Sandbox projects, are also sorted into the Docutils Link List_.
.. _Docutils Link List: https://docutils.sourceforge.io/docs/user/links.html
.. TODO: update the list of important sandbox projects (here or in the link list?)
The remainder of this section contained descriptions and links to obsolete or abadoned projects. Commented out because this give an impression of an attic instead of a place for experimenting.
Projects that are now implemented in Docutils
<code-block-directive>_ contains documentation, reasoning and experimental code for support of syntax highlight in Docutils. Preparational work for thecode_ directive available since version 0.9.LaTeX math for reST_ by Jens J. Mortensen writes Math to LaTeX or MathML. This is the base of math_ support since version 0.8.
.. _code: docutils/docs/ref/rst/directives.txt#code .. _math: docutils/docs/ref/rst/directives.txt#math .. _LaTeX math for reST: http://docutils.sf.net/sandbox/jensj/latex_math/
Documenting Python
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.
The sandbox contains some of the pervious work done on enabling Docutils to
write the "Documenting Python"__ using rST.
__ http://docs.python.org/doc/doc.html
Edward Loper's sandbox <http://docutils.sf.net/sandbox/edloper/docpy/>__. The example "asyncore.rst" file was originally adapted by Steve Holden and Bill Sconce.Dave Kuhlman's sandbox <http://docutils.sf.net/sandbox/dkuhlman/>__ andhis homepage <http://www.rexx.com/~dkuhlman/rstpythonlatex_intro.html>__.docpy-writer <http://docutils.sf.net/sandbox/docpy-writer/>__ was used for ctypes documentation.
.. _Python documentation: http://docs.python.org/ .. _reStructuredText: http://docutils.sf.net/rst.html .. _Sphinx: http://sphinx.pocoo.org/
Project Infrastructure
docutils-update <infrastructure/docutils-update>_ is a script that
was 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.
.. _web site: http://docutils.sf.net/docs/dev/website.html
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.