table of contents
- testing 3.12.2-1
- unstable 3.12.2-4
- experimental 3.12.2-1.1~exp2
PYDOC3.12(1) | General Commands Manual | PYDOC3.12(1) |
NAME¶
pydoc3.12 - the Python documentation tool
SYNOPSIS¶
pydoc3.12 name
pydoc3.12 -k keyword
pydoc3.12 -p port
pydoc3.12 -g
pydoc3.12 -w module [...]
DESCRIPTION¶
pydoc3.12 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.12 -k keyword Search for a keyword in the synopsis lines of all available modules.
pydoc3.12 -p port Start an HTTP server on the given port on the local machine.
pydoc3.12 -g Pop up a graphical interface for finding and serving documentation.
pydoc3.12 -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¶
Moshe Zadka, based on "pydoc --help"