web/index.txt

   1 .. header:: Docutils | Documentation_ | `Project page`_ | Download_
   2
   3 ===================================
   4  Docutils: Documentation Utilities
   5 ===================================
   6 ---------------------------------------------------------
   7  Written in Python, for General- and Special-Purpose Use
   8 ---------------------------------------------------------
   9
  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.
  15
  16 ----------------------------------------------------------------------
  17
  18
  19 Overview
  20 ========
  21
  22 **To get up & running quickly**, see the Quick-Start_ section of the
  23 README_ file. The only requirement_ for running Docutils is Python_.
  24
  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.
  28
  29 The SourceForge `project page`_ has links to the tracker, mailing
  30 lists, and code repository.
  31
  32 All **discussion** about Docutils takes place on the `mailing lists`_.
  33
  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.
  39
  40 If you find a **bug**, please `file a bug report`_ or mail to the
  41 docutils-users_ mailing list.
  42
  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_.
  48
  49 Download
  50 ========
  51
  52 `Release packages`_ can be downloaded from PyPI_.
  53 See the `release notes`_ for a list of changes since the previous
  54 release.
  55
  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!
  59
  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.
  64
  65 ----------------------------------------------------------------------
  66
  67 .. class:: credits
  68
  69 Web site, tracker, mailing lists, and repository hosted by |SourceForge|_.
  70 Powered by |Python|_.
  71
  72 .. |---| unicode:: U+02014 .. em dash
  73    :trim:
  74
  75 .. _snapshots:
  76     https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
  77 .. _trunk directory:
  78     https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/
  79 .. _patch tracker:
  80     https://sourceforge.net/p/docutils/patches/
  81 .. _file a bug report:
  82     https://docutils.sourceforge.io/BUGS.html#how-to-report-a-bug
  83 .. _mailing lists:
  84     https://docutils.sourceforge.io/docs/user/mailing-lists.html
  85 .. _docutils-users:
  86     https://docutils.sourceforge.io/docs/user/mailing-lists.html
  87     #docutils-users
  88 .. _docutils-develop:
  89     https://docutils.sourceforge.io/docs/user/mailing-lists.html
  90     #docutils-develop
  91 .. _sandbox: https://docutils.sourceforge.io/sandbox/README.html
  92 .. _reStructuredText: https://docutils.sourceforge.io/rst.html
  93 .. _project page: https://sourceforge.net/p/docutils
  94 .. _To Do list: https://docutils.sourceforge.io/docs/dev/todo.html
  95 .. _README: https://docutils.sourceforge.io/README.html
  96 .. _Quick-Start: https://docutils.sourceforge.io/README.html#quick-start
  97 .. _Documentation:
  98 .. _Project Documentation Overview:
  99     https://docutils.sourceforge.io/docs/index.html
 100 .. _Docutils' Subversion repository:
 101     https://docutils.sourceforge.io/docs/dev/repository.html
 102 .. _requirement: https://docutils.sourceforge.io/README.html#requirements
 103 .. _release packages: https://pypi.org/project/docutils/#files
 104 .. _PyPI: https://pypi.org
 105 .. _release notes: https://docutils.sourceforge.io/RELEASE-NOTES.html
 106
 107 .. |SourceForge| image::
 108    https://sourceforge.net/sflogo.php?group_id=38414
 109    :alt: SourceForge
 110    :align: middle
 111    :height: 1.5em
 112 .. _SourceForge: https://sourceforge.net/
 113
 114 .. |Python| image:: python.png
 115    :alt: Python
 116    :align: middle
 117    :height: 1em
 118 .. _Python: https://www.python.org/
 119
 120
 121
 122 ..
 123    Local Variables:
 124    mode: indented-text
 125    indent-tabs-mode: nil
 126    sentence-end-double-space: t
 127    fill-column: 70
 128    End: