Differences between revisions 47 and 49 (spanning 2 versions)
Revision 47 as of 2012-06-06 20:29:39
Size: 2806
Comment:
Revision 49 as of 2013-06-05 19:08:07
Size: 2780
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Documentation for Python and related libraries falls into a variety of categories.
The first that most users encounter is the ''standard documentation'', which can
be found in a variety of places.
Documentation for Python and related libraries falls into a variety of categories. The first that most users encounter is the ''standard documentation'', which can be found in a variety of places.
Line 6: Line 4:
The standard documentation for the most recent stable release of Python can always be found at http://docs.python.org/. It's easy to search that version using Google; the search box at the top of the page on that site will perform a Google search of only that site. Downloadable versions for printing and interactive use are also made available at that location.
Line 7: Line 6:
The standard documentation for the most recent stable release of Python can always
be found at http://docs.python.org/. It's easy to search that version using Google;
the search box at the top of the page on that site will perform a Google search of
only that site. Downloadable versions for printing and interactive use are also made
available at that location.
Older versions of the standard documentation are kept available as well, since many users have to maintain code for older versions of the interpreter as well. These can be found at http://www.python.org/doc/versions.html.
Line 13: Line 8:
Older versions of the standard documentation are kept available as well, since many
users have to maintain code for older versions of the interpreter as well. These
can be found at http://www.python.org/doc/versions.html.

The standard documentation is maintained as part of the Python sources, and is
released along with Python itself. This should be considered the most definitive
documentation on the language definition, the standard library, and the programming
interface for the CPython interpreter itself.
The standard documentation is maintained as part of the Python sources, and is released along with Python itself. This should be considered the most definitive documentation on the language definition, the standard library, and the programming interface for the CPython interpreter itself.
Line 23: Line 11:

There are a range of PythonBooks that have been published in printed forms by a
variety of commercial publishers. These range from introductory material on
programming using Python as an example language to in-depth treatments of specific
topics from a Python programmer's perspective. Look for them at your favorite
bookseller, or check them out from your local public or university library.
There are a range of PythonBooks that have been published in printed forms by a variety of commercial publishers. These range from introductory material on programming using Python as an example language to in-depth treatments of specific topics from a Python programmer's perspective. Look for them at your favorite bookseller, or check them out from your local public or university library.
Line 31: Line 14:

Additional introductory and tutorial materials are also available; a list of pointers
is maintained at http://www.python.org/doc/Intros.html.
Additional introductory and tutorial materials are also available; a list of pointers is maintained at http://www.python.org/doc/Intros.html.
Line 36: Line 17:

There are a number of documents and other resources available for Python users in
languages other than English. These include translations of standard and third-party
documents as well as original documents written in other languages. A list of these
is maintained at http://www.python.org/doc/NonEnglish.html.
There are a number of documents and other resources available for Python users in languages other than English. These include translations of standard and third-party documents as well as original documents written in other languages. A list of these is maintained at http://www.python.org/doc/NonEnglish.html.
Line 43: Line 20:
Sometimes all you need is a hint. Many people have created quick reference guides over the years. The list below was culled from a posting to news:comp.lang.python:
Line 44: Line 22:
Sometimes all you need is a hint. Many people have created quick reference guides
over the years. The list below was culled from a posting to [[news:comp.lang.python]]:

  * http://www.limsi.fr/Individu/pointal/python/pqrc/
 
* http://rgruet.free.fr/#QuickRef
  * http://www.onlamp.com/python/excerpt/PythonPocketRef/examples/python.pdf
  * http://www.aprendelo.com/rec/python-cheat-sheet.html
 * http://www.limsi.fr/Individu/pointal/python/pqrc/
 * http://rgruet.free.fr/#QuickRef
 * http://www.onlamp.com/python/excerpt/PythonPocketRef/examples/python.pdf
 * http://www.aprendelo.com/rec/python-cheat-sheet.html
Line 53: Line 28:
An easy-to use standard Python documentation plugin for Eclipse SDK. Very handy if you need to get a quick reference from official Python documentation.
Line 54: Line 30:
An easy-to use standard Python documentation plugin for Eclipse SDK. Very handy
if you need to get a quick reference from official Python documentation.

 * http://pydoc.tk/
 * http://haidamaka.herokuapp.com/

Documentation for Python and related libraries falls into a variety of categories. The first that most users encounter is the standard documentation, which can be found in a variety of places.

Standard Documentation

The standard documentation for the most recent stable release of Python can always be found at http://docs.python.org/. It's easy to search that version using Google; the search box at the top of the page on that site will perform a Google search of only that site. Downloadable versions for printing and interactive use are also made available at that location.

Older versions of the standard documentation are kept available as well, since many users have to maintain code for older versions of the interpreter as well. These can be found at http://www.python.org/doc/versions.html.

The standard documentation is maintained as part of the Python sources, and is released along with Python itself. This should be considered the most definitive documentation on the language definition, the standard library, and the programming interface for the CPython interpreter itself.

Published Books

There are a range of PythonBooks that have been published in printed forms by a variety of commercial publishers. These range from introductory material on programming using Python as an example language to in-depth treatments of specific topics from a Python programmer's perspective. Look for them at your favorite bookseller, or check them out from your local public or university library.

Alternate Introductory Documentation

Additional introductory and tutorial materials are also available; a list of pointers is maintained at http://www.python.org/doc/Intros.html.

Non-English Documentation

There are a number of documents and other resources available for Python users in languages other than English. These include translations of standard and third-party documents as well as original documents written in other languages. A list of these is maintained at http://www.python.org/doc/NonEnglish.html.

Quick Reference Guides

Sometimes all you need is a hint. Many people have created quick reference guides over the years. The list below was culled from a posting to news:comp.lang.python:

Eclipse SDK Documentation plugin

An easy-to use standard Python documentation plugin for Eclipse SDK. Very handy if you need to get a quick reference from official Python documentation.

PythonDocumentation (last edited 2014-09-24 11:40:25 by Alexey Gaidamaka)

Unable to edit the page? See the FrontPage for instructions.