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