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