1 .. header:: Docutils | Documentation_ | `Project page`_ | Download_
3 ===================================
4 Docutils: Documentation Utilities
5 ===================================
6 ---------------------------------------------------------
7 Written in Python, for General- and Special-Purpose Use
8 ---------------------------------------------------------
10 Docutils is an open-source text processing system for processing
11 plaintext documentation into useful formats, such as HTML, LaTeX,
12 man-pages, OpenDocument, or XML.
13 It includes reStructuredText_, the easy to read, easy to use,
14 what-you-see-is-what-you-get plaintext markup language.
16 ----------------------------------------------------------------------
22 **To get up & running quickly**, see the Quick-Start_ section of the
23 README_ file. The only requirement_ for running Docutils is Python_.
25 All **documentation** can be reached from the `Project Documentation
26 Overview`_. If something is unclear or missing, ask at the
27 docutils-users_ mailing list.
29 The |sourceforge| `project page`_ has links to the tracker, mailing
30 lists, and code repository.
32 All **discussion** about Docutils takes place on the `mailing lists`_.
34 To the developers of an open source project, **feedback** is a great
35 motivator and is very welcome. We also rely on feedback for
36 determining what features to implement. Thus, if you tell us what you
37 need, we may help! Please post any feedback to the
38 docutils-users_ mailing list.
40 If you find a **bug**, please `file a bug report`_ or mail to the
41 docutils-users_ mailing list.
43 We welcome all kinds of **contributions**. There's a `To Do list`_ full
44 of ideas awaiting a champion. If you have any questions regarding how to
45 extend Docutils, please feel free to ask on the docutils-develop_ mailing
46 list. **Patch** submissions should be filed in the `patch tracker`_
47 (preferred) or sent to docutils-develop_.
52 `Release packages`_ can be downloaded from PyPI_.
53 See the `release notes`_ for a list of changes since the previous
56 Snapshots_ [#]_ from the `Docutils' Subversion repository`_
57 usually contain *more features* and *fewer bugs*
58 than the "official" releases |---| they're not only for developers!
60 .. [#] Snapshots are created on-demand by Sourceforge. You can
61 download a snapshot of the complete `trunk directory`_ (docutils,
62 sandbox_, and web) or any sub-directory. Browse to the
63 desired directory and click the "Download Snapshot" button.
65 ----------------------------------------------------------------------
69 Web site, tracker, mailing lists, and repository hosted by |SourceForge|_.
72 .. |---| unicode:: U+02014 .. em dash
76 https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
77 .. _trunk directory: https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/
78 .. _patch tracker: https://sourceforge.net/p/docutils/patches/
79 .. _file a bug report: BUGS.html#how-to-report-a-bug
80 .. _mailing lists: docs/user/mailing-lists.html
81 .. _docutils-users: docs/user/mailing-lists.html#docutils-users
82 .. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
83 .. _sandbox: sandbox/README.html
84 .. _reStructuredText: rst.html
85 .. _project page: https://sourceforge.net/p/docutils
86 .. _To Do list: docs/dev/todo.html
87 .. _README: README.html
88 .. _Quick-Start: README.html#quick-start
90 .. _Project Documentation Overview: docs/index.html
91 .. _Docutils' Subversion repository: docs/dev/repository.html
92 .. _requirement: README.html#requirements
93 .. _release packages: https://pypi.org/project/docutils/#files
94 .. _PyPI: https://pypi.org
95 .. _release notes: RELEASE-NOTES.html
97 .. |SourceForge| image::
98 https://sourceforge.net/sflogo.php?group_id=38414
102 .. _SourceForge: https://sourceforge.net/
104 .. |Python| image:: python.png
108 .. _Python: https://www.python.org/
115 indent-tabs-mode: nil
116 sentence-end-double-space: t