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, LaTeX,
  10 man-pages, open-document or XML.
  11 It includes reStructuredText_, the easy to read, easy to use,
  12 what-you-see-is-what-you-get plaintext markup language.
  13
  14 ----------------------------------------------------------------------
  15
  16 Overview
  17 ========
  18
  19 **To get up & running quickly**, see the Quick-Start_ section of the
  20 README_ file.
  21
  22 All **documentation** can be reached from the `Docutils Project
  23 Documentation Overview`_.
  24
  25 To the developers of an open source project, **feedback** is a great
  26 motivator and is very welcome.  We also rely on feedback for
  27 determining what features to implement.  Thus, if you tell us what you
  28 need, you may just get it!  Please post any feedback to the
  29 Docutils-users_ mailing list.
  30
  31 All **discussion** about Docutils takes place on the `mailing lists`_.
  32
  33 If you find a **bug**, please file a `bug report`_ or send email to
  34 the Docutils-users_ mailing list.  **Patch** submissions should be
  35 filed in the `patch tracker`_ (preferred) or sent to Docutils-develop_
  36 (where you will be asked to send them to the `patch tracker`_).
  37
  38 We welcome all kinds of **contributions**.  There's a `To Do list`_
  39 full of interesting ideas awaiting a champion.  If you have any
  40 questions regarding how to extend Docutils, please feel free to ask on
  41 the Docutils-develop_ mailing list.  Please also consider **donating**
  42 to Docutils: |donate|.
  43
  44 The only **requirement** for running Docutils is Python_ 2.3 or later.
  45 (For Docutils 0.5, Python 2.2.1+ is required.
  46 Up to Docutils 0.4, Python 2.1 is required.)
  47 From version 0.6, Docutils is compatible with Python 3 (see README_ for
  48 details).
  49
  50 Docutils is in active development and APIs should be considered
  51 **experimental** subject to change at any time.  Although *any time* is a time
  52 after serious thought and discussion.
  53
  54
  55 Download
  56 ========
  57
  58 We recommend that you use a snapshot_ from `Docutils' Subversion
  59 repository`_. The snapshots usually contain *more features* and *fewer bugs*
  60 than the "official" releases |---| they're not only for developers!
  61
  62 The latest **release package** is `docutils-0.8.1.tgz`__.  It was
  63 released on 2011-07-08 and is mostly intended for distributors.  See
  64 the `release notes`_ for a list of changes since the previous release
  65 (0.7).
  66
  67 __ http://prdownloads.sourceforge.net/docutils/docutils-0.8.1.tar.gz?download
  68 .. _release notes: RELEASE-NOTES.html#release-0-8-1-2011-08-30
  69
  70 The Sandbox_ contains experimental, contributed code. You can download a
  71 complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a
  72 subset.
  73
  74 .. attention:: The repository was moved on 2011-12-02 at revision 7232
  75    from BerliOS to |SourceForge|_.
  76
  77    Subversion repository was hosted by |BerliOS|_ for years,
  78    *many thanks for the support*.
  79
  80 .. class:: credits
  81
  82 Web site, tracker and mailing lists and subversion repository hosted by |SourceForge|_.
  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 .. _snapshot:
 104    http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar
 105 .. _Snapshot of the Sandbox:
 106    http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/?view=tar
 107 .. _browse the Sandbox:
 108    http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/
 109 .. _bug report: http://sourceforge.net/tracker/?group_id=38414&atid=422030
 110 .. _patch tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422032
 111 .. _mailing lists: docs/user/mailing-lists.html
 112 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 113 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 114 .. _sandbox: sandbox/README.html
 115 .. _reStructuredText: rst.html
 116 .. _project files page:
 117    http://sourceforge.net/project/showfiles.php?group_id=38414
 118 .. _To Do list: docs/dev/todo.html
 119 .. _README: README.html
 120 .. _Quick-Start: README.html#quick-start
 121 .. _Docutils Project Documentation Overview: docs/index.html
 122 .. _Docutils' Subversion repository: docs/dev/repository.html
 123 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 124    :target: http://sourceforge.net/donate/index.php?group_id=38414
 125    :align: middle
 126    :width: 88
 127    :height: 32
 128    :alt: Support the Docutils project!
 129 .. |SourceForge| image::
 130    http://sourceforge.net/sflogo.php?group_id=38414
 131    :alt: SourceForge Logo
 132    :align: middle
 133    :class: borderless
 134    :width: 88
 135    :height: 31
 136 .. |BerliOS| image::
 137    http://developer.berlios.de/sflogo.php?group_id=2920
 138    :alt: BerliOS Logo
 139    :align: middle
 140    :class: borderless
 141    :width: 124
 142    :height: 32
 143 .. |Python| image:: python.png
 144    :alt: Python Logo
 145    :align: middle
 146    :class: borderless
 147    :width: 193
 148    :height: 32
 149 .. _BerliOS: http://developer.berlios.de/
 150 .. _SourceForge: http://sourceforge.net/
 151 .. _Python: http://www.python.org/
 152
 153
 154 \f
 155 ..
 156    Local Variables:
 157    mode: indented-text
 158    indent-tabs-mode: nil
 159    sentence-end-double-space: t
 160    fill-column: 70
 161    End: