summaryrefslogtreecommitdiff
path: root/sandbox/README.txt
blob: 4bd5b2620cb13c2ac713c4dd34d096888e163d23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
=====================
 README: The Sandbox
=====================

The Sandbox_ is a place to play around, to try out and share ideas.
It's a part of the Subversion repository but it isn't distributed as
part of Docutils_ releases.  Each developer who wants to play here
should create their own subdirectory (suggested name: SourceForge ID,
or given name + family initial).

It's OK to make a mess here!  But please, play nice.

For more information, please see the `Docutils Project Policies`_.

.. This link gives readers a way to *get to* the sandbox:
.. _Sandbox: ./

.. _Docutils: http://docutils.sourceforge.net/
.. _Docutils Project Policies:
   http://docutils.sourceforge.net/docs/dev/policies.html#the-sandbox


Sandbox Projects
================

.. contents:: :local:


Project Infrastructure
----------------------

`docutils-update <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.

.. _web site: http://docutils.sf.net/docs/dev/website.html


Documenting Python
------------------

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

__ 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/>`__ and `his homepage
  <http://www.rexx.com/~dkuhlman/rstpythonlatex_intro.html>`__.


Other Sandbox Projects
----------------------

For other sandbox projects, please see the `Docutils Link List`_.

.. _Docutils Link List: http://docutils.sf.net/docs/user/links.html