Differences between revisions 40 and 42 (spanning 2 versions)
Revision 40 as of 2004-07-21 00:46:54
Size: 2856
Editor: dsl254-010-130
Comment:
Revision 42 as of 2005-09-16 05:25:13
Size: 1805
Editor: FredDrake
Comment: documentation overview
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 5:
==== Beginners ====
''Join the fun and start learning today!''
 * [http://www.python.org/doc/Newbies.html Python for Beginners]
 * MovingToPythonFromOtherLanguages
== Standard Documentation ==
Line 8: Line 7:
==== Topic guides ====
''Development-Guides-R-Us!''
 * WebProgramming - more aptly put, Server-side programming, as of current
 * GuiProgramming - some (in fact, rather a few) available GUIs for Python
 * ThreadProgramming - so far, some source code and comments on aspects of this
 * DatabaseProgramming - Pointers to information on how to approach this
 * DistributedProgramming
 * SoYouWanna - Python solutions to software problems (currently a few, mostly high-level tasks)
 * PythonDevWisdom - Useful snippets for advanced Python programmers
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 18: Line 13:
 * HandlingExceptions, WritingExceptionClasses
 * SubclassingDictionaries, SortingListsOfDictionaries, KeepingListsInDictionaries
 * WorkingWithTime, RssLibraries, UsingPickle, MiniDom, EscapingHtml
 * CgiScripts, XmlRpc, DocXmlRpcServer, BaseHttpServer
 * PatternProgramming
 * MetaClasses
 * MixIns
 * PythonSpeed - some of the issues related to Python's speed are discussed here
 * ["Unicode"]
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 28: Line 17:
==== Other ====
 * [http://www.python.org/doc/ Documentation Central]
 * PythonBooks
 * PythonPapers
 * PythonQuestions
 * PythonPhilosophy
 * LanguageComparisons
 * [http://www.cafepy.com/articles/python_types_and_objects/ Python Types and Objects], [http://www.cafepy.com/articles/python_attributes_and_methods/ Python Attributes and Methods] - Two part series on new-style objects in v2.2 and up.
 * [http://www.tuangou.org/python/tut/index.html] - Python Tutorial Simplified Chinese Translation
== Published Books ==
Line 38: Line 19:
----
'''Discussion'''
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 41: Line 25:
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. == Alternate Introductory Documentation ==
Line 43: Line 27:
Additional introductory and tutorial materials are also available; a list of pointers
is maintained at http://www.python.org/doc/Intros.html.
Line 44: Line 30:
Like the [http://www.php.net/manual/en/ PHP Manual] at [http://www.php.net/]. == Non-English Documentation ==
Line 46: Line 32:

----
  I think that's a great idea. But I think it should appear on a separate wiki.
  We're going to need to do some steering for this wiki:
  If every python related project in the world tries to make their wiki a
  [http://c2.com/cgi/wiki?WalledGarden walled garden] within ''this'' wiki,
  we're going to run into problems. RecentChanges will be a total mess of a zillion projects.
  Let's talk. -- LionKimbro [[DateTime(2003-10-02T03:15:01Z)]]
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.

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.

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.

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

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