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, OpenDocument, 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
  17 Overview
  18 ========
  19
  20 **To get up & running quickly**, see the Quick-Start_ section of the
  21 README_ file. The only requirement_ for running Docutils is Python_.
  22
  23 All **documentation** can be reached from the `Project Documentation
  24 Overview`_. If something is unclear or missing, ask at the
  25 docutils-users_ mailing list.
  26
  27 The |sourceforge| `project page`_ has links to the tracker, mailing
  28 lists, and code repository.
  29
  30 All **discussion** about Docutils takes place on the `mailing lists`_.
  31
  32 To the developers of an open source project, **feedback** is a great
  33 motivator and is very welcome.  We also rely on feedback for
  34 determining what features to implement.  Thus, if you tell us what you
  35 need, we may help!  Please post any feedback to the
  36 docutils-users_ mailing list.
  37
  38 If you find a **bug**, please `file a bug report`_ or mail to the
  39 docutils-users_ mailing list.
  40
  41 We welcome all kinds of **contributions**.  There's a `To Do list`_ full
  42 of ideas awaiting a champion.  If you have any questions regarding how to
  43 extend Docutils, please feel free to ask on the docutils-develop_ mailing
  44 list. **Patch** submissions should be filed in the `patch tracker`_
  45 (preferred) or sent to docutils-develop_.
  46
  47 Download
  48 ========
  49
  50 `Release packages`_ can be downloaded from PyPI_. They are mostly intended
  51 for distributors.  See the `release notes`_ for a list of changes since the
  52 previous release.
  53
  54 We recommend that you use a snapshot_ [#snapshots]_ from `Docutils' Subversion
  55 repository`_. The snapshots usually contain *more features* and *fewer bugs*
  56 than the "official" releases |---| they're not only for developers!
  57
  58 .. [#snapshots] Snapshots are created on-demand by Sourceforge.  You can
  59    download a snapshot of the complete `trunk directory`_ (docutils,
  60    sandbox_, prest/perl and web) or any sub-directory. Browse to the
  61    desired directory and click the "Download Snapshot" button.
  62
  63 ----------------------------------------------------------------------
  64
  65 .. class:: credits
  66
  67 Web site, tracker, mailing lists, and repository hosted by |SourceForge|_.
  68 Powered by |Python|_.
  69
  70 .. |---| unicode:: U+02014 .. em dash
  71    :trim:
  72
  73 .. _snapshot:
  74    https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
  75 .. _trunk directory: https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/
  76 .. _patch tracker: https://sourceforge.net/p/docutils/patches/
  77 .. _file a bug report: BUGS.html#how-to-report-a-bug
  78 .. _mailing lists: docs/user/mailing-lists.html
  79 .. _docutils-users: docs/user/mailing-lists.html#docutils-users
  80 .. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
  81 .. _sandbox: sandbox/README.html
  82 .. _reStructuredText: rst.html
  83 .. _project page: https://sourceforge.net/p/docutils
  84 .. _To Do list: docs/dev/todo.html
  85 .. _README: README.html
  86 .. _Quick-Start: README.html#quick-start
  87 .. _Project Documentation Overview: docs/index.html
  88 .. _Docutils' Subversion repository: docs/dev/repository.html
  89 .. _requirement: README.html#requirements
  90 .. _release packages: https://pypi.org/project/docutils/#files
  91 .. _PyPI: https://pypi.org
  92 .. _release notes: RELEASE-NOTES.html
  93
  94 .. |SourceForge| image::
  95    https://sourceforge.net/sflogo.php?group_id=38414
  96    :alt: SourceForge
  97    :align: middle
  98    :height: 1.5em
  99 .. _SourceForge: https://sourceforge.net/
 100
 101 .. |Python| image:: python.png
 102    :alt: Python
 103    :align: middle
 104    :height: 1em
 105 .. _Python: https://www.python.org/
 106
 107
 108 \f
 109 ..
 110    Local Variables:
 111    mode: indented-text
 112    indent-tabs-mode: nil
 113    sentence-end-double-space: t
 114    fill-column: 70
 115    End: