CPAN functionality for python - requirements

Fredrik Lundh fredrik at pythonware.com
Wed Feb 28 15:21:18 CET 2001


Sean Reifschneider wrote:
> Don't get me wrong, I'm all for documentation.  The lack of "javadoc" for
> Python has really hurt though...

current CVS version:

>>> import pydoc
>>> print pydoc.__doc__
Generate Python documentation in HTML or as text for interactive use.

At the shell command line outside of Python, run "pydoc <name>" to show
documentation on something.  <name> may be the name of a Python function,
module, package, or a dotted reference to a class or function within a
module or module in a package.  Alternatively, the argument can be the
path to a Python source file.

Or, at the shell prompt, run "pydoc -k <keyword>" to search for a keyword
in the one-line descriptions of modules.

Or, at the shell prompt, run "pydoc -p <port>" to start an HTTP server
on a given port on the local machine to generate documentation web pages.

Or, at the shell prompt, run "pydoc -w <name>" to write out the HTML
documentation for a module to a file named "<name>.html".

In the Python interpreter, do "from pydoc import help" to provide online
help.  Calling help(thing) on a Python object documents the object.

Cheers /F





More information about the Python-list mailing list