pydoc3.4(1) the Python documentation tool


pydoc3.4 name

pydoc3.4 -k keyword

pydoc3.4 -p port

pydoc3.4 -g

pydoc3.4 -w module [...]


pydoc3.4 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.

pydoc3.4 -k keyword Search for a keyword in the synopsis lines of all available modules.

pydoc3.4 -p port Start an HTTP server on the given port on the local machine.

pydoc3.4 -g Pop up a graphical interface for finding and serving documentation.

pydoc3.4 -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.


Moshe Zadka, based on "pydoc --help"