mirror of
https://github.com/AdaCore/cpython.git
synced 2026-02-12 12:57:15 -08:00
1f2d56dfc2
svn+ssh://pythondev@svn.python.org/python/branches/py3k
................
r70707 | benjamin.peterson | 2009-03-30 09:51:56 -0500 (Mon, 30 Mar 2009) | 58 lines
Merged revisions 70578,70599,70641-70642,70650,70660-70661,70674,70691,70697-70698,70700,70704 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r70578 | benjamin.peterson | 2009-03-23 22:24:56 -0500 (Mon, 23 Mar 2009) | 1 line
this is better written using assertRaises
........
r70599 | benjamin.peterson | 2009-03-25 16:42:51 -0500 (Wed, 25 Mar 2009) | 1 line
this can be slightly less ugly
........
r70641 | guilherme.polo | 2009-03-27 16:43:08 -0500 (Fri, 27 Mar 2009) | 3 lines
Adjusted _tkinter to compile without warnings when WITH_THREAD is not
defined (part of issue #5035)
........
r70642 | georg.brandl | 2009-03-27 19:48:48 -0500 (Fri, 27 Mar 2009) | 1 line
Fix typo.
........
r70650 | benjamin.peterson | 2009-03-28 14:16:10 -0500 (Sat, 28 Mar 2009) | 1 line
give os.symlink and os.link() better parameter names #5564
........
r70660 | georg.brandl | 2009-03-28 14:52:58 -0500 (Sat, 28 Mar 2009) | 1 line
Switch to fixed Sphinx version.
........
r70661 | georg.brandl | 2009-03-28 14:57:36 -0500 (Sat, 28 Mar 2009) | 2 lines
Add section numbering to some of the larger subdocuments.
........
r70674 | guilherme.polo | 2009-03-29 05:19:05 -0500 (Sun, 29 Mar 2009) | 1 line
Typo fix.
........
r70691 | raymond.hettinger | 2009-03-29 13:51:11 -0500 (Sun, 29 Mar 2009) | 1 line
Make life easier for non-CPython implementations.
........
r70697 | benjamin.peterson | 2009-03-29 16:22:35 -0500 (Sun, 29 Mar 2009) | 1 line
this has been fixed since 2.6 (I love removing these)
........
r70698 | benjamin.peterson | 2009-03-29 16:31:05 -0500 (Sun, 29 Mar 2009) | 1 line
thanks to guido's bytecode verifier, this is fixed
........
r70700 | benjamin.peterson | 2009-03-29 16:50:14 -0500 (Sun, 29 Mar 2009) | 1 line
use the awesome new status iterator
........
r70704 | benjamin.peterson | 2009-03-29 21:49:32 -0500 (Sun, 29 Mar 2009) | 1 line
there's actually three methods here #5600
........
................
33 lines
1.0 KiB
ReStructuredText
33 lines
1.0 KiB
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::
|
|
:numbered:
|
|
|
|
intro.rst
|
|
style.rst
|
|
rest.rst
|
|
markup.rst
|
|
fromlatex.rst
|