Skip to main content

Browse the archive

Staging
v0.5.1
https://github.com/python/cpython
09 December 2020, 11:06:31 UTC
Revision a08a3c514d848146577458f87da8c343a8002ddc authored by Georg Brandl on 13 August 2009, 08:40:50 UTC, committed by Georg Brandl on 13 August 2009, 08:40:50 UTC 
Merged revisions 74196 via svnmerge from
 
svn+ssh://svn.python.org/python/branches/py3k

........
  r74196 | benjamin.peterson | 2009-07-25 03:02:01 +0200 (Sa, 25 Jul 2009) | 1 line

  account for range() py3k change
........
1 parent 4a3b309
Raw File
Tip revision: a08a3c514d848146577458f87da8c343a8002ddc authored by Georg Brandl on 13 August 2009, 08:40:50 UTC
Merged revisions 74196 via svnmerge from
Tip revision: a08a3c5
index.rst 
.. _documenting-index:

######################
  Documenting Python
######################


The Python language has a substantial body of documentation, much of it
contributed by various authors. The markup used for the Python documentation is
`reStructuredText`_, developed by the `docutils`_ project, amended by custom
directives and using a toolset named `Sphinx`_ to postprocess the HTML output.

This document describes the style guide for our documentation, the custom
reStructuredText markup introduced to support Python documentation and how it
should be used, as well as the Sphinx build system.

.. _reStructuredText: http://docutils.sf.net/rst.html
.. _docutils: http://docutils.sf.net/
.. _Sphinx: http://sphinx.pocoo.org/

If you're interested in contributing to Python's documentation, there's no need
to write reStructuredText if you're not so inclined; plain text contributions
are more than welcome as well.

.. toctree::
   :numbered:

   intro.rst
   style.rst
   rest.rst
   markup.rst
   fromlatex.rst
back to top