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.
  42
  43 .. NO DONATE on new sf platform
  44    Please also consider **donating** to Docutils: |donate|.
  45
  46 The only **requirement** for running Docutils is Python_
  47
  48 * After Docutil 0.14 Python 2.4 and Python 2.5 support will be dropped.
  49 * Docutils 0.10 dropped Python 2.3 support.
  50 * For Docutils 0.5, Python 2.2.1+ is required.
  51 * Up to Docutils 0.4, Python 2.1 is required.
  52
  53 * From version 0.6, Docutils is compatible with Python 3 (see README_ for
  54   details).
  55
  56 Docutils is in active development and APIs should be considered
  57 **experimental** subject to change at any time.  Although *any time* is a time
  58 after serious thought and discussion.
  59
  60
  61 Download
  62 ========
  63
  64 .. Note::
  65
  66    Snapshots are supported by sourceforge directly.
  67    The whole trunk is packed docutils, sandbox, prest/perl and web:
  68
  69      https://sourceforge.net/p/docutils/code/HEAD/tarball
  70
  71    or only the docutils package:
  72
  73      http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
  74
  75   Click the download snapshot button.
  76
  77   The snapshosts listed below are created on website updates.
  78
  79 We recommend that you use a snapshot_ from `Docutils' Subversion
  80 repository`_. The snapshots usually contain *more features* and *fewer bugs*
  81 than the "official" releases |---| they're not only for developers!
  82
  83 The latest **release package** is `docutils-0.14.tar.gz`__.  It was
  84 released on 2017-08-03 and is mostly intended for distributors.  See
  85 the `release notes`_ for a list of changes since the previous release.
  86
  87 __ https://sourceforge.net/projects/docutils/files/docutils/0.14/docutils-0.14.tar.gz/download
  88
  89 .. _release notes: RELEASE-NOTES.html
  90
  91 The Sandbox_ contains experimental, contributed code. You can download a
  92 complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a
  93 subset.
  94
  95 .. class:: credits
  96
  97 Web site, tracker and mailing lists and subversion repository hosted by |SourceForge|_.
  98 Powered by |Python|_.
  99
 100 .. class:: hidden
 101
 102 Google should index the mailing lists: `Docutils-users
 103 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
 104 `Docutils-develop
 105 <http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__,
 106 and `Docutils-checkins
 107 <http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__.
 108
 109 .. |---| unicode:: U+02014 .. em dash
 110    :trim:
 111 .. _Deploying Docutils Securely: docs/howto/security.html
 112 .. _Docutils sprint:
 113    http://wiki.python.org/moin/PyCon2006/Sprints/DocutilsSprint
 114 .. _PyCon 2006: http://us.pycon.org/TX2006/HomePage
 115 .. _dugui: http://docutils.sourceforge.net/sandbox/dugui/
 116 .. _LaTeX math support:
 117    http://docutils.sourceforge.net/sandbox/latex_directive/
 118
 119 .. _snapshot:
 120    http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
 121 .. _snapshot of the Sandbox:
 122    http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
 123 .. _browse the Sandbox:
 124    http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
 125
 126 .. _bug report: http://docutils.sourceforge.net/BUGS.html
 127 .. _patch tracker: http://sourceforge.net/p/docutils/patches/
 128 .. _mailing lists: docs/user/mailing-lists.html
 129 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 130 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 131 .. _sandbox: sandbox/README.html
 132 .. _reStructuredText: rst.html
 133 .. _project files page:
 134    http://sourceforge.net/project/showfiles.php?group_id=38414
 135 .. _To Do list: docs/dev/todo.html
 136 .. _README: README.html
 137 .. _Quick-Start: README.html#quick-start
 138 .. _Docutils Project Documentation Overview: docs/index.html
 139 .. _Docutils' Subversion repository: docs/dev/repository.html
 140 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 141    :target: http://sourceforge.net/donate/index.php?group_id=38414
 142    :align: middle
 143    :width: 88
 144    :height: 32
 145    :alt: Support the Docutils project!
 146 .. |SourceForge| image::
 147    http://sourceforge.net/sflogo.php?group_id=38414
 148    :alt: SourceForge Logo
 149    :align: middle
 150    :class: borderless
 151    :width: 88
 152    :height: 31
 153 .. |BerliOS| image::
 154    http://developer.berlios.de/sflogo.php?group_id=2920
 155    :alt: BerliOS Logo
 156    :align: middle
 157    :class: borderless
 158    :width: 124
 159    :height: 32
 160 .. |Python| image:: python.png
 161    :alt: Python Logo
 162    :align: middle
 163    :class: borderless
 164    :width: 193
 165    :height: 32
 166 .. _BerliOS: http://developer.berlios.de/
 167 .. _SourceForge: http://sourceforge.net/
 168 .. _Python: http://www.python.org/
 169
 170
 171 \f
 172 ..
 173    Local Variables:
 174    mode: indented-text
 175    indent-tabs-mode: nil
 176    sentence-end-double-space: t
 177    fill-column: 70
 178    End: