web/index.txt

   1 ===================================
   2  Docutils: Documentation Utilities
   3 ===================================
   4 ---------------------------------------------------------
   5  Written in Python, for General- and Special-Purpose Use
   6 ---------------------------------------------------------
   7
   8 Docutils is an open-source text processing system for processing
   9 plaintext documentation into useful formats, such as HTML or LaTeX.
  10 It includes reStructuredText_, the easy to read, easy to use,
  11 what-you-see-is-what-you-get plaintext markup language.
  12
  13 ----------------------------------------------------------------------
  14
  15 News
  16 ====
  17
  18 **2006-11-12**: `Deploying Docutils Securely`_ doc added to project.
  19
  20 The `Docutils sprint`_ at `PyCon 2006`_ is over.  Results include
  21 dugui_ (a GUI for Docutils) and some work on `LaTeX math support`_,
  22 both awaiting completion.
  23
  24 Overview
  25 ========
  26
  27 **To get up & running quickly**, see the Quick-Start_ section of the
  28 README_ file.
  29
  30 All **documentation** can be reached from the `Docutils Project
  31 Documentation Overview`_.
  32
  33 To the developers of an open source project, **feedback** is a great
  34 motivator and is very welcome.  We also rely on feedback for
  35 determining what features to implement.  Thus, if you tell us what you
  36 need, you may just get it!  Please post any feedback to the
  37 Docutils-users_ mailing list.
  38
  39 All **discussion** about Docutils takes place on the `mailing lists`_.
  40
  41 If you find a **bug**, please file a `bug report`_ or send email to
  42 the Docutils-users_ mailing list.  **Patch** submissions should be
  43 filed in the `patch tracker`_ or sent to Docutils-develop_.
  44
  45 We welcome all kinds of **contributions**.  There's a `To Do list`_
  46 full of interesting ideas awaiting a champion.  If you have any
  47 questions regarding how to extend Docutils, please feel free to ask on
  48 the Docutils-develop_ mailing list.  Please also consider **donating**
  49 to Docutils: |donate|.
  50
  51 The only **requirement** for running Docutils is Python_ 2.2 or later.
  52 (Python 2.1 may be used providing the compiler package is installed.
  53 The compiler package can be found in the Tools/ directory of Python's
  54 source distribution.)
  55
  56 Docutils is in active development and should be considered **highly
  57 experimental**.  APIs are subject to change at any time.
  58
  59
  60 Download
  61 ========
  62
  63 We recommend that you use the latest **snapshot**,
  64 `<docutils-snapshot.tgz>`_.  The snapshots usually contain *more
  65 features* and *fewer bugs* than the "official" releases |---| they're
  66 not only for developers!
  67
  68 The latest **release package** is `docutils-0.4.tgz`__.  It was
  69 released on 2006-01-09 and is mostly intended for distributors.  See
  70 the `release notes`_ for a list of changes since the previous release
  71 (0.3.9).
  72
  73 __ http://prdownloads.sourceforge.net/docutils/docutils-0.4.tar.gz?download
  74 .. _release notes: RELEASE-NOTES.html#release-0-4-2006-01-09
  75
  76 More snapshots:
  77
  78 - `Snapshot of the Sandbox`_ (experimental, contributed code; see the
  79   Sandbox_ for details)
  80 - `Snapshot of DocFactory project files`_ (this is a subset of the
  81   Sandbox snapshot above; you don't need both)
  82
  83 You can also access `Docutils' Subversion repository`_ directly.
  84
  85 .. class:: credits
  86
  87 Web site, tracker and mailing lists hosted by |SourceForge|_.
  88 Subversion repository hosted by |BerliOS|_.
  89 Powered by |Python|_.
  90
  91 .. class:: hidden
  92
  93 Google should index the mailing lists: `Docutils-users
  94 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
  95 `Docutils-develop
  96 <http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__,
  97 and `Docutils-checkins
  98 <http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__.
  99
 100 .. |---| unicode:: U+02014 .. em dash
 101    :trim:
 102 .. _Deploying Docutils Securely: docs/howto/security.html
 103 .. _Docutils sprint:
 104    http://wiki.python.org/moin/PyCon2006/Sprints/DocutilsSprint
 105 .. _PyCon 2006: http://us.pycon.org/TX2006/HomePage
 106 .. _dugui: http://docutils.sourceforge.net/sandbox/dugui/
 107 .. _LaTeX math support:
 108    http://docutils.sourceforge.net/sandbox/latex_directive/
 109 .. _latest snapshot: http://docutils.sourceforge.net/docutils-snapshot.tgz
 110 .. _Snapshot of the Sandbox:
 111    http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz
 112 .. _Snapshot of DocFactory project files:
 113    http://docutils.sourceforge.net/docfactory-snapshot.tgz
 114 .. _bug report: http://sourceforge.net/tracker/?group_id=38414&atid=422030
 115 .. _patch tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422032
 116 .. _mailing lists: docs/user/mailing-lists.html
 117 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 118 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 119 .. _sandbox: sandbox/README.html
 120 .. _reStructuredText: rst.html
 121 .. _project files page:
 122    http://sourceforge.net/project/showfiles.php?group_id=38414
 123 .. _To Do list: docs/dev/todo.html
 124 .. _README: README.html
 125 .. _Quick-Start: README.html#quick-start
 126 .. _Docutils Project Documentation Overview: docs/index.html
 127 .. _Docutils' Subversion repository: docs/dev/repository.html
 128 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 129    :target: http://sourceforge.net/donate/index.php?group_id=38414
 130    :align: middle
 131    :width: 88
 132    :height: 32
 133    :alt: Support the Docutils project!
 134 .. |SourceForge| image::
 135    http://sourceforge.net/sflogo.php?group_id=38414
 136    :alt: SourceForge Logo
 137    :align: middle
 138    :class: borderless
 139    :width: 88
 140    :height: 31
 141 .. |BerliOS| image::
 142    http://developer.berlios.de/sflogo.php?group_id=2920
 143    :alt: BerliOS Logo
 144    :align: middle
 145    :class: borderless
 146    :width: 124
 147    :height: 32
 148 .. |Python| image:: python.png
 149    :alt: Python Logo
 150    :align: middle
 151    :class: borderless
 152    :width: 193
 153    :height: 32
 154 .. _BerliOS: http://developer.berlios.de/
 155 .. _SourceForge: http://sourceforge.net/
 156 .. _Python: http://www.python.org/
 157
 158
 159 \f
 160 ..
 161    Local Variables:
 162    mode: indented-text
 163    indent-tabs-mode: nil
 164    sentence-end-double-space: t
 165    fill-column: 70
 166    End: