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    Since april, 18 sourceforge project snapshots are possible::
  63
  64      http://sourceforge.net/p/docutils/code/7646/tarball
  65
  66   BUT
  67
  68   1. take a long time
  69   2. must be initiated from a browser, really ?
  70   3. release HEAD does not work.
  71   4. the whole repository, including trunk, tags and branches is packed together,
  72      this explains, probably, the time it takes.
  73
  74   The provided snapshosts are created on website updates.
  75
  76 We recommend that you use a snapshot_ from `Docutils' Subversion
  77 repository`_. The snapshots usually contain *more features* and *fewer bugs*
  78 than the "official" releases |---| they're not only for developers!
  79
  80 The latest **release package** is `docutils-0.12.tgz`__.  It was
  81 released on 2014-07-06 and is mostly intended for distributors.  See
  82 the `release notes`_ for a list of changes since the previous release
  83 (0.11).
  84
  85 __ http://prdownloads.sourceforge.net/docutils/docutils-0.12.tar.gz?download
  86 .. _release notes: RELEASE-NOTES.html#release-0-12-2014-07-06
  87
  88 The Sandbox_ contains experimental, contributed code. You can download a
  89 complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a
  90 subset.
  91
  92 .. class:: credits
  93
  94 Web site, tracker and mailing lists and subversion repository hosted by |SourceForge|_.
  95 Powered by |Python|_.
  96
  97 .. class:: hidden
  98
  99 Google should index the mailing lists: `Docutils-users
 100 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
 101 `Docutils-develop
 102 <http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__,
 103 and `Docutils-checkins
 104 <http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__.
 105
 106 .. |---| unicode:: U+02014 .. em dash
 107    :trim:
 108 .. _Deploying Docutils Securely: docs/howto/security.html
 109 .. _Docutils sprint:
 110    http://wiki.python.org/moin/PyCon2006/Sprints/DocutilsSprint
 111 .. _PyCon 2006: http://us.pycon.org/TX2006/HomePage
 112 .. _dugui: http://docutils.sourceforge.net/sandbox/dugui/
 113 .. _LaTeX math support:
 114    http://docutils.sourceforge.net/sandbox/latex_directive/
 115
 116 .. _snapshot:
 117    http://docutils.sourceforge.net/docutils-snapshot.tgz
 118 .. _snapshot of the Sandbox:
 119    http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz
 120 .. _browse the Sandbox:
 121    http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
 122
 123 .. _bug report: http://docutils.sourceforge.net/BUGS.html
 124 .. _patch tracker: http://sourceforge.net/p/docutils/patches/
 125 .. _mailing lists: docs/user/mailing-lists.html
 126 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 127 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 128 .. _sandbox: sandbox/README.html
 129 .. _reStructuredText: rst.html
 130 .. _project files page:
 131    http://sourceforge.net/project/showfiles.php?group_id=38414
 132 .. _To Do list: docs/dev/todo.html
 133 .. _README: README.html
 134 .. _Quick-Start: README.html#quick-start
 135 .. _Docutils Project Documentation Overview: docs/index.html
 136 .. _Docutils' Subversion repository: docs/dev/repository.html
 137 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 138    :target: http://sourceforge.net/donate/index.php?group_id=38414
 139    :align: middle
 140    :width: 88
 141    :height: 32
 142    :alt: Support the Docutils project!
 143 .. |SourceForge| image::
 144    http://sourceforge.net/sflogo.php?group_id=38414
 145    :alt: SourceForge Logo
 146    :align: middle
 147    :class: borderless
 148    :width: 88
 149    :height: 31
 150 .. |BerliOS| image::
 151    http://developer.berlios.de/sflogo.php?group_id=2920
 152    :alt: BerliOS Logo
 153    :align: middle
 154    :class: borderless
 155    :width: 124
 156    :height: 32
 157 .. |Python| image:: python.png
 158    :alt: Python Logo
 159    :align: middle
 160    :class: borderless
 161    :width: 193
 162    :height: 32
 163 .. _BerliOS: http://developer.berlios.de/
 164 .. _SourceForge: http://sourceforge.net/
 165 .. _Python: http://www.python.org/
 166
 167
 168 \f
 169 ..
 170    Local Variables:
 171    mode: indented-text
 172    indent-tabs-mode: nil
 173    sentence-end-double-space: t
 174    fill-column: 70
 175    End: