Doc/documenting/index.rst

   1 .. _documenting-index:
   2
   3 ######################
   4   Documenting Python
   5 ######################
   6
   7
   8 The Python language has a substantial body of documentation, much of it
   9 contributed by various authors. The markup used for the Python documentation is
  10 `reStructuredText`_, developed by the `docutils`_ project, amended by custom
  11 directives and using a toolset named `Sphinx`_ to postprocess the HTML output.
  12
  13 This document describes the style guide for our documentation, the custom
  14 reStructuredText markup introduced to support Python documentation and how it
  15 should be used, as well as the Sphinx build system.
  16
  17 .. _reStructuredText: http://docutils.sf.net/rst.html
  18 .. _docutils: http://docutils.sf.net/
  19 .. _Sphinx: http://sphinx.pocoo.org/
  20
  21 If you're interested in contributing to Python's documentation, there's no need
  22 to write reStructuredText if you're not so inclined; plain text contributions
  23 are more than welcome as well.
  24
  25 .. toctree::
  26    :numbered:
  27
  28    intro.rst
  29    style.rst
  30    rest.rst
  31    markup.rst
  32    fromlatex.rst