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 From version 0.6, Docutils is compatible with Python 3 (see README_ for
  47 details).
  48
  49 Docutils is in active development and should be considered **experimental**.
  50 APIs are subject to change at any time.
  51
  52
  53 Download
  54 ========
  55
  56 We recommend that you use a snapshot_ from `Docutils' Subversion
  57 repository`_. The snapshots usually contain *more features* and *fewer bugs*
  58 than the "official" releases |---| they're not only for developers!
  59
  60 The latest **release package** is `docutils-0.8.1.tgz`__.  It was
  61 released on 2011-07-08 and is mostly intended for distributors.  See
  62 the `release notes`_ for a list of changes since the previous release
  63 (0.7).
  64
  65 __ http://prdownloads.sourceforge.net/docutils/docutils-0.8.1.tar.gz?download
  66 .. _release notes: RELEASE-NOTES.html#release-0-8-1-2011-08-30
  67
  68 The Sandbox_ contains experimental, contributed code. You can download a
  69 complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a
  70 subset.
  71
  72 .. attention:: The repository was moved on 2011-12-02 at revision 7232
  73    from BerliOS to |SourceForge|_.
  74
  75    Subversion repository was hosted by |BerliOS|_ for years,
  76    *many thanks for the support*.
  77
  78 .. class:: credits
  79
  80 Web site, tracker and mailing lists and subversion repository hosted by |SourceForge|_.
  81 Powered by |Python|_.
  82
  83 .. class:: hidden
  84
  85 Google should index the mailing lists: `Docutils-users
  86 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
  87 `Docutils-develop
  88 <http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__,
  89 and `Docutils-checkins
  90 <http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__.
  91
  92 .. |---| unicode:: U+02014 .. em dash
  93    :trim:
  94 .. _Deploying Docutils Securely: docs/howto/security.html
  95 .. _Docutils sprint:
  96    http://wiki.python.org/moin/PyCon2006/Sprints/DocutilsSprint
  97 .. _PyCon 2006: http://us.pycon.org/TX2006/HomePage
  98 .. _dugui: http://docutils.sourceforge.net/sandbox/dugui/
  99 .. _LaTeX math support:
 100    http://docutils.sourceforge.net/sandbox/latex_directive/
 101 .. _snapshot:
 102    http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar
 103 .. _Snapshot of the Sandbox:
 104    http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/?view=tar
 105 .. _browse the Sandbox:
 106    http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/
 107 .. _bug report: http://sourceforge.net/tracker/?group_id=38414&atid=422030
 108 .. _patch tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422032
 109 .. _mailing lists: docs/user/mailing-lists.html
 110 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 111 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 112 .. _sandbox: sandbox/README.html
 113 .. _reStructuredText: rst.html
 114 .. _project files page:
 115    http://sourceforge.net/project/showfiles.php?group_id=38414
 116 .. _To Do list: docs/dev/todo.html
 117 .. _README: README.html
 118 .. _Quick-Start: README.html#quick-start
 119 .. _Docutils Project Documentation Overview: docs/index.html
 120 .. _Docutils' Subversion repository: docs/dev/repository.html
 121 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 122    :target: http://sourceforge.net/donate/index.php?group_id=38414
 123    :align: middle
 124    :width: 88
 125    :height: 32
 126    :alt: Support the Docutils project!
 127 .. |SourceForge| image::
 128    http://sourceforge.net/sflogo.php?group_id=38414
 129    :alt: SourceForge Logo
 130    :align: middle
 131    :class: borderless
 132    :width: 88
 133    :height: 31
 134 .. |BerliOS| image::
 135    http://developer.berlios.de/sflogo.php?group_id=2920
 136    :alt: BerliOS Logo
 137    :align: middle
 138    :class: borderless
 139    :width: 124
 140    :height: 32
 141 .. |Python| image:: python.png
 142    :alt: Python Logo
 143    :align: middle
 144    :class: borderless
 145    :width: 193
 146    :height: 32
 147 .. _BerliOS: http://developer.berlios.de/
 148 .. _SourceForge: http://sourceforge.net/
 149 .. _Python: http://www.python.org/
 150
 151
 152 \f
 153 ..
 154    Local Variables:
 155    mode: indented-text
 156    indent-tabs-mode: nil
 157    sentence-end-double-space: t
 158    fill-column: 70
 159    End: