sandbox/README.txt

   1 ..                            -*- rst-mode -*-
   2
   3 =====================
   4  README: The Sandbox
   5 =====================
   6
   7 The Sandbox_ is a place to play around, to try out and share ideas. The
   8 `sandbox/`_ directory is a part of the Subversion repository but it isn't
   9 distributed as part of Docutils_ releases.
  10
  11 It's OK to make a mess in the Sandbox! But please, play nice.
  12
  13 A project-specific subdirectory should be created for each new project.
  14 Any developer who wants to play in the sandbox may create their own
  15 subdirectory (suggested name: SourceForge ID, or given name + family
  16 initial), but project directories are recommended over personal directories,
  17 which discourage collaboration.
  18
  19 For more information, please see the `Docutils Project Policies`_. The
  20 Sandbox_ is mirrored at the Docutils web site, so the `Docutils Web Site`_
  21 documentation applies as well.
  22
  23
  24 .. These links give readers a way to *go to* the sandbox:
  25 .. _sandbox:
  26 .. _sandbox/: ./
  27
  28 .. _Docutils: http://docutils.sourceforge.net/
  29 .. _Docutils Project Policies:
  30    http://docutils.sourceforge.net/docs/dev/policies.html#the-sandbox
  31 .. _Docutils Web Site: http://docutils.sourceforge.net/docs/dev/website.html
  32
  33
  34 Sandbox Projects
  35 ================
  36
  37 .. contents:: :local:
  38
  39
  40 Project Infrastructure
  41 ----------------------
  42
  43 `docutils-update <infrastructure/docutils-update>`_ is a script that
  44 is installed as a cron job on BerliOS.de to automatically update the
  45 Docutils `web site`_ whenever the SVN files change.  Any .html
  46 document with a corresponding .txt file is regenerated whenever the
  47 .txt file changes.
  48
  49 .. _web site: http://docutils.sf.net/docs/dev/website.html
  50
  51
  52 Documenting Python
  53 ------------------
  54
  55 Some work has been done on enabling Docutils to write the
  56 `"Documenting Python" variant of LaTeX`__, which we're calling
  57 "DocPy".
  58
  59 __ http://docs.python.org/doc/doc.html
  60
  61 * `Edward Loper's sandbox
  62   <http://docutils.sf.net/sandbox/edloper/docpy/>`__.  The example
  63   "asyncore.rst" file was originally adapted by Steve Holden and Bill
  64   Sconce.
  65
  66 * `Dave Kuhlman's sandbox
  67   <http://docutils.sf.net/sandbox/dkuhlman/>`__ and `his homepage
  68   <http://www.rexx.com/~dkuhlman/rstpythonlatex_intro.html>`__.
  69
  70 * `docpy-writer <http://docutils.sf.net/sandbox/docpy-writer/>`__ was
  71   used for ctypes documentation.
  72
  73 Other Sandbox Projects
  74 ----------------------
  75
  76 See the `sandbox/`_ directory for a complete list.
  77
  78 * Many Sandbox projects, are sorted into the `Docutils Link List`_.
  79
  80 * `<code-block-directive>`_ contains documentation, reasoning and
  81   experimental code for support of syntax highlight in docutils.
  82
  83 * `<latex-variants>`_ is a place to try out and discuss variants of the
  84   latex2e writer.
  85
  86
  87 .. _Docutils Link List: http://docutils.sf.net/docs/user/links.html