1 ===================================
2 Docutils: Documentation Utilities
3 ===================================
4 ---------------------------------------------------------
5 Written in Python, for General- and Special-Purpose Use
6 ---------------------------------------------------------
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.
14 ----------------------------------------------------------------------
19 **To get up & running quickly**, see the Quick-Start_ section of the
22 All **documentation** can be reached from the `Docutils Project
23 Documentation Overview`_.
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.
31 All **discussion** about Docutils takes place on the `mailing lists`_.
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`_).
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.
43 .. NO DONATE on new sf platform
44 Please also consider **donating** to Docutils: |donate|.
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
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.
62 Snapshots are supported by sourceforge directly.
63 The whole trunk is packed docutils, sandbox, prest/perl and web:
65 https://sourceforge.net/p/docutils/code/HEAD/tarball
67 or only the docutils package:
69 http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
71 Click the download snapshot button.
73 The snapshosts listed below are created on website updates.
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!
79 The latest **release package** is `docutils-0.12.tgz`__. It was
80 released on 2014-07-06 and is mostly intended for distributors. See
81 the `release notes`_ for a list of changes since the previous release
84 __ http://prdownloads.sourceforge.net/docutils/docutils-0.12.tar.gz?download
85 .. _release notes: RELEASE-NOTES.html#release-0-12-2014-07-06
87 The Sandbox_ contains experimental, contributed code. You can download a
88 complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a
93 Web site, tracker and mailing lists and subversion repository hosted by |SourceForge|_.
98 Google should index the mailing lists: `Docutils-users
99 <http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__,
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>`__.
105 .. |---| unicode:: U+02014 .. em dash
107 .. _Deploying Docutils Securely: docs/howto/security.html
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/
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/
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
141 :alt: Support the Docutils project!
142 .. |SourceForge| image::
143 http://sourceforge.net/sflogo.php?group_id=38414
144 :alt: SourceForge Logo
150 http://developer.berlios.de/sflogo.php?group_id=2920
156 .. |Python| image:: python.png
162 .. _BerliOS: http://developer.berlios.de/
163 .. _SourceForge: http://sourceforge.net/
164 .. _Python: http://www.python.org/
171 indent-tabs-mode: nil
172 sentence-end-double-space: t