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