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 News
  16 ====
  17
  18 The `Docutils sprint`_ at `PyCon 2006`_ is over.  Results include
  19 dugui_ (a GUI for Docutils) and some work on `LaTeX math support`_,
  20 both awaiting completion.
  21
  22 Overview
  23 ========
  24
  25 **To get up & running quickly**, see the Quick-Start_ section of the
  26 README_ file.
  27
  28 All **documentation** can be reached from the `Docutils Project
  29 Documentation Overview`_.
  30
  31 To the developers of an open source project, **feedback** is a great
  32 motivator and is very welcome.  We also rely on feedback for
  33 determining what features to implement.  Thus, if you tell us what you
  34 need, you may just get it!  Please post any feedback to the
  35 Docutils-users_ mailing list.
  36
  37 All **discussion** about Docutils takes place on the `mailing lists`_.
  38
  39 If you find a **bug**, please file a `bug report`_ or send email to
  40 the Docutils-users_ mailing list.  **Patch** submissions should be
  41 filed in the `patch tracker`_ or sent to Docutils-develop_.
  42
  43 We welcome all kinds of **contributions**.  There's a `To Do list`_
  44 full of interesting ideas awaiting a champion.  If you have any
  45 questions regarding how to extend Docutils, please feel free to ask on
  46 the Docutils-develop_ mailing list.  Please also consider **donating**
  47 to Docutils: |donate|.
  48
  49 The only **requirement** for running Docutils is Python_ 2.2 or later.
  50 (Python 2.1 may be used providing the compiler package is installed.
  51 The compiler package can be found in the Tools/ directory of Python's
  52 source distribution.)
  53
  54 Docutils is in active development and should be considered **highly
  55 experimental**.  APIs are subject to change at any time.
  56
  57
  58 Download
  59 ========
  60
  61 We recommend that you use the latest **snapshot**,
  62 `<docutils-snapshot.tgz>`_.  The snapshots usually contain *more
  63 features* and *fewer bugs* than the "official" releases |---| they're
  64 not only for developers!
  65
  66 The latest **release package** is `docutils-0.4.tgz`__.  It was
  67 released on 2006-01-09 and is mostly intended for distributors.  See
  68 the `release notes`_ for a list of changes since the previous release
  69 (0.3.9).
  70
  71 __ http://prdownloads.sourceforge.net/docutils/docutils-0.4.tar.gz?download
  72 .. _release notes: RELEASE-NOTES.html#release-0-4-2006-01-09
  73
  74 More snapshots:
  75
  76 - `Snapshot of the Sandbox`_ (experimental, contributed code; see the
  77   Sandbox_ for details)
  78 - `Snapshot of DocFactory project files`_ (this is a subset of the
  79   Sandbox snapshot above; you don't need both)
  80
  81 You can also access `Docutils' Subversion repository`_ directly.
  82
  83 .. class:: credits
  84
  85 Web site, tracker and mailing lists hosted by |SourceForge|_.
  86 Subversion repository hosted by |BerliOS|_.
  87 Powered by |Python|_.
  88
  89 .. class:: hidden
  90
  91 Google should index the mailing lists: `Docutils-users
  92 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
  93 `Docutils-develop
  94 <http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__,
  95 and `Docutils-checkins
  96 <http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__.
  97
  98 .. |---| unicode:: U+02014 .. em dash
  99    :trim:
 100 .. _Docutils sprint:
 101    http://wiki.python.org/moin/PyCon2006/Sprints/DocutilsSprint
 102 .. _PyCon 2006: http://us.pycon.org/TX2006/HomePage
 103 .. _dugui: http://docutils.sourceforge.net/sandbox/dugui/
 104 .. _LaTeX math support:
 105    http://docutils.sourceforge.net/sandbox/latex_directive/
 106 .. _latest snapshot: http://docutils.sourceforge.net/docutils-snapshot.tgz
 107 .. _Snapshot of the Sandbox:
 108    http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz
 109 .. _Snapshot of DocFactory project files:
 110    http://docutils.sourceforge.net/docfactory-snapshot.tgz
 111 .. _bug report: http://sourceforge.net/tracker/?group_id=38414&atid=422030
 112 .. _patch tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422032
 113 .. _mailing lists: docs/user/mailing-lists.html
 114 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 115 .. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop
 116 .. _sandbox: sandbox/README.html
 117 .. _reStructuredText: rst.html
 118 .. _project files page:
 119    http://sourceforge.net/project/showfiles.php?group_id=38414
 120 .. _To Do list: docs/dev/todo.html
 121 .. _README: README.html
 122 .. _Quick-Start: README.html#quick-start
 123 .. _Docutils Project Documentation Overview: docs/index.html
 124 .. _Docutils' Subversion repository: docs/dev/repository.html
 125 .. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
 126    :target: http://sourceforge.net/donate/index.php?group_id=38414
 127    :align: middle
 128    :width: 88
 129    :height: 32
 130    :alt: Support the Docutils project!
 131 .. |SourceForge| image::
 132    http://sourceforge.net/sflogo.php?group_id=38414
 133    :alt: SourceForge Logo
 134    :align: middle
 135    :class: borderless
 136    :width: 88
 137    :height: 31
 138 .. |BerliOS| image::
 139    http://developer.berlios.de/sflogo.php?group_id=2920
 140    :alt: BerliOS Logo
 141    :align: middle
 142    :class: borderless
 143    :width: 124
 144    :height: 32
 145 .. |Python| image:: python.png
 146    :alt: Python Logo
 147    :align: middle
 148    :class: borderless
 149    :width: 193
 150    :height: 32
 151 .. _BerliOS: http://developer.berlios.de/
 152 .. _SourceForge: http://sourceforge.net/
 153 .. _Python: http://www.python.org/
 154
 155
 156 \f
 157 ..
 158    Local Variables:
 159    mode: indented-text
 160    indent-tabs-mode: nil
 161    sentence-end-double-space: t
 162    fill-column: 70
 163    End: