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`_ or sent to Docutils-develop_.
  35
  36 We welcome all kinds of **contributions**.  There's a `To Do list`_
  37 full of interesting ideas awaiting a champion.  If you have any
  38 questions regarding how to extend Docutils, please feel free to ask on
  39 the Docutils-develop_ mailing list.  Please also consider **donating**
  40 to Docutils: |donate|.
  41
  42 The only **requirement** for running Docutils is Python_ 2.2 or later.
  43 (Up to docutils-0.4 Python 2.1 may be used providing the compiler package
  44 is installed. The compiler package can be found in the Tools/ directory of
  45 Python's source distribution.)
  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 latest **release package** is `docutils-0.5.tgz`__.  It was
  60 released on 2008-06-25 and is mostly intended for distributors.  See
  61 the `release notes`_ for a list of changes since the previous release
  62 (0.4).
  63
  64 __ http://prdownloads.sourceforge.net/docutils/docutils-0.5.tar.gz?download
  65 .. _release notes: RELEASE-NOTES.html#release-0-5-2008-06-25
  66
  67 More snapshots:
  68
  69 - `Snapshot of the Sandbox`_ (experimental, contributed code; see the
  70   Sandbox_ for details)
  71 - `Snapshot of DocFactory project files`_ (this is a subset of the
  72   Sandbox snapshot above; you don't need both)
  73
  74 You can also access `Docutils' Subversion repository`_ directly.
  75
  76 .. class:: credits
  77
  78 Web site, tracker and mailing lists hosted by |SourceForge|_.
  79 Subversion repository hosted by |BerliOS|_.
  80 Powered by |Python|_.
  81
  82 .. class:: hidden
  83
  84 Google should index the mailing lists: `Docutils-users
  85 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
  86 `Docutils-develop
  87 <http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__,
  88 and `Docutils-checkins
  89 <http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__.
  90
  91 .. |---| unicode:: U+02014 .. em dash
  92    :trim:
  93 .. _Deploying Docutils Securely: docs/howto/security.html
  94 .. _Docutils sprint:
  95    http://wiki.python.org/moin/PyCon2006/Sprints/DocutilsSprint
  96 .. _PyCon 2006: http://us.pycon.org/TX2006/HomePage
  97 .. _dugui: http://docutils.sourceforge.net/sandbox/dugui/
  98 .. _LaTeX math support:
  99    http://docutils.sourceforge.net/sandbox/latex_directive/
 100 .. _latest snapshot: http://docutils.sourceforge.net/docutils-snapshot.tgz
 101 .. _Snapshot of the Sandbox:
 102    http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz
 103 .. _Snapshot of DocFactory project files:
 104    http://docutils.sourceforge.net/docfactory-snapshot.tgz
 105 .. _bug report: http://sourceforge.net/tracker/?group_id=38414&atid=422030
 106 .. _patch tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422032
 107 .. _mailing lists: docs/user/mailing-lists.html
 108 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 109 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 110 .. _sandbox: sandbox/README.html
 111 .. _reStructuredText: rst.html
 112 .. _project files page:
 113    http://sourceforge.net/project/showfiles.php?group_id=38414
 114 .. _To Do list: docs/dev/todo.html
 115 .. _README: README.html
 116 .. _Quick-Start: README.html#quick-start
 117 .. _Docutils Project Documentation Overview: docs/index.html
 118 .. _Docutils' Subversion repository: docs/dev/repository.html
 119 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 120    :target: http://sourceforge.net/donate/index.php?group_id=38414
 121    :align: middle
 122    :width: 88
 123    :height: 32
 124    :alt: Support the Docutils project!
 125 .. |SourceForge| image::
 126    http://sourceforge.net/sflogo.php?group_id=38414
 127    :alt: SourceForge Logo
 128    :align: middle
 129    :class: borderless
 130    :width: 88
 131    :height: 31
 132 .. |BerliOS| image::
 133    http://developer.berlios.de/sflogo.php?group_id=2920
 134    :alt: BerliOS Logo
 135    :align: middle
 136    :class: borderless
 137    :width: 124
 138    :height: 32
 139 .. |Python| image:: python.png
 140    :alt: Python Logo
 141    :align: middle
 142    :class: borderless
 143    :width: 193
 144    :height: 32
 145 .. _BerliOS: http://developer.berlios.de/
 146 .. _SourceForge: http://sourceforge.net/
 147 .. _Python: http://www.python.org/
 148
 149
 150 \f
 151 ..
 152    Local Variables:
 153    mode: indented-text
 154    indent-tabs-mode: nil
 155    sentence-end-double-space: t
 156    fill-column: 70
 157    End: