pydoc2 (1) - Linux Manuals

pydoc2: the Python documentation tool

NAME

pydoc2.7 - the Python documentation tool

SYNOPSIS

pydoc2.7 name

pydoc2.7 -k keyword

pydoc2.7 -p port

pydoc2.7 -g

pydoc2.7 -w module [...]

DESCRIPTION

pydoc2.7 name Show text documentation on something. name may be the name of a Python keyword, topic, function, module, or package, or a dotted reference to a class or function within a module or module in a package. If name contains a '/', it is used as the path to a Python source file to document. If name is 'keywords', 'topics', or 'modules', a listing of these things is displayed.

pydoc2.7 -k keyword Search for a keyword in the synopsis lines of all available modules.

pydoc2.7 -p port Start an HTTP server on the given port on the local machine.

pydoc2.7 -g Pop up a graphical interface for finding and serving documentation.

pydoc2.7 -w name [...] Write out the HTML documentation for a module to a file in the current directory. If name contains a '/', it is treated as a filename; if it names a directory, documentation is written for all the contents.

AUTHOR