mirror of
https://github.com/python/cpython.git
synced 2025-08-04 00:48:58 +00:00
f608c61301
svn+ssh://pythondev@svn.python.org/python/trunk ........ r67154 | hirokazu.yamamoto | 2008-11-07 21:46:17 -0600 (Fri, 07 Nov 2008) | 1 line Issue #4071: ntpath.abspath returned an empty string for long unicode path. ........ r67157 | georg.brandl | 2008-11-08 05:47:44 -0600 (Sat, 08 Nov 2008) | 2 lines Don't use "HOWTO" as the title for all howto .tex files. ........ r67158 | georg.brandl | 2008-11-08 05:48:20 -0600 (Sat, 08 Nov 2008) | 2 lines Update "Documenting" a bit. Concentrate on Python-specifics. ........ r67159 | georg.brandl | 2008-11-08 06:52:25 -0600 (Sat, 08 Nov 2008) | 2 lines Fix warning. ........ r67175 | benjamin.peterson | 2008-11-08 19:44:32 -0600 (Sat, 08 Nov 2008) | 1 line update link ........ r67176 | benjamin.peterson | 2008-11-08 19:52:32 -0600 (Sat, 08 Nov 2008) | 1 line fix comment ........ r67189 | benjamin.peterson | 2008-11-11 15:56:06 -0600 (Tue, 11 Nov 2008) | 1 line use correct name ........ r67224 | georg.brandl | 2008-11-15 02:10:04 -0600 (Sat, 15 Nov 2008) | 2 lines #4324: fix getlocale() argument. ........ r67225 | brett.cannon | 2008-11-15 16:33:25 -0600 (Sat, 15 Nov 2008) | 1 line Clarify the docs for the 'strict' argument to httplib.HTTPConnection. ........ r67226 | brett.cannon | 2008-11-15 16:40:44 -0600 (Sat, 15 Nov 2008) | 4 lines The docs for httplib.HTTPConnection.putheader() have claimed for quite a while that their could be an arbitrary number of values passed in. Turns out the code did not match that. The code now matches the docs. ........ r67227 | georg.brandl | 2008-11-16 02:00:17 -0600 (Sun, 16 Nov 2008) | 2 lines #4316: fix configure.in markup problem. ........ r67234 | benjamin.peterson | 2008-11-16 11:54:55 -0600 (Sun, 16 Nov 2008) | 1 line run autoconf ........
31 lines
1,010 B
ReStructuredText
31 lines
1,010 B
ReStructuredText
.. _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::
|
|
|
|
intro.rst
|
|
style.rst
|
|
rest.rst
|
|
markup.rst
|
|
fromlatex.rst
|