DOKK / manpages / debian 11 / python-dev-is-python3 / pydoc.1.en
PYDOC3.9(1) General Commands Manual PYDOC3.9(1)

pydoc3.9 - the Python documentation tool

pydoc3.9 name

pydoc3.9 -k keyword

pydoc3.9 -p port

pydoc3.9 -g

pydoc3.9 -w module [...]

pydoc3.9 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.9 -k keyword Search for a keyword in the synopsis lines of all available modules.

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

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

pydoc3.9 -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"