Understanding Python Documentation

Shalabh Chaturvedi shalabh at cafepy.com
Thu Nov 24 18:57:18 CET 2005


Josh Cronemeyer wrote:
> Hi,
> 
> I have very little experience programming in python but considerable 
> experience with java.  One thing that is frustrating me is the differences in 
> the documentation style.  Javadocs, at the top level are just a list of 
> packages.  Drilling down on a package reveals a list of classes in that 
> package, and drilling down on a class reveals a list of methods for that 
> class.  Is there something similar for python?  
> 
> The closest thing I have found to this for python is 
> http://www.python.org/doc/2.4.2/modindex.html  which really isn't the same 
> thing at all.
> 
> wxpython has their documentation like this http://www.wxpython.org/docs/api/  
> is there something like this for the rest of python? 

Here is the Python 2.3 standard lib docs generated using epydoc:

http://epydoc.sourceforge.net/stdlib/

In look and feel it's more like javadoc. However always check the 
standard library documentation for usage and examples that might not be 
in this.

Cheers,
Shalabh




More information about the Python-list mailing list