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