Differences between revisions 12 and 56 (spanning 44 versions)
Revision 12 as of 2003-09-06 18:14:51
Size: 1461
Editor: dsl254-010-130
Comment: + WritingExceptionClasses
Revision 56 as of 2014-09-24 11:40:25
Size: 2790
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
A guide and a discussion page for PythonDocumentation. 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 3: Line 3:
==== Beginners ====
''Join the fun and start learning today!''
 * [http://www.python.org/doc/Newbies.html Python for Beginners]
 * MovingToPythonFromOtherLanguages
== 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.
Line 8: Line 6:
==== Topic guides ====
''Development-Guides-R-Us!''
 * WebProgramming
 * GuiProgramming
 * ThreadProgramming
 * DatabaseProgramming
 * DistributedProgramming
 * SoYouWanna - Python solutions to software problems
 * PythonDevWisdom - Useful snippets for advanced Python programmers
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 18: Line 8:
 * WritingExceptionClasses 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 20: Line 10:
==== Other ====
 * [http://www.python.org/doc/ Documentation Central]
 * PythonBooks
 * PythonPapers
 * PythonQuestions
 * PythonPhilosophy
 * LanguageComparisons
== 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.
Line 28: Line 13:
----
'''Discussion:'''
== 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.
Line 31: Line 16:
Please!! get a wiki running side-by-side with the docs eg: 1 corresponding wikiable page for every page here in the pydocs. The startup data is simply that of the docs, so just mirror their structure. Then after the wiki docs start offering lots of useful information, the actual doc writers can incorporate this. To summarize, I think Python's documentation (like the library reference) is basically a big melange of api data and some snippets of useful info. This wiki will help replace those places that just use API data to fill up space, and turn it into something better. == 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.
Line 33: Line 19:
Like the [http://www.php.net/manual/en/ PHP Manual] at [http://www.php.net/].
For css see: [http://www.css-stuff.com/ CSS stuff]
== 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:

 * 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

== 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.

 * http://sourceforge.net/projects/pydoc/ http://sourceforge.net/p/pydoc/wiki/Howto/

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.