pydoc3(1)

pydoc31

The python documentation tool

Part of pydoc3.13(1).

Usage

pydoc3.13 name

pydoc3.13 -k keyword

pydoc3.13 -p port

pydoc3.13 -g

pydoc3.13 -w module []

Overview

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

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

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

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

Releases

8 releases since Debian 6.0 (Squeeze); the text changed 7 times.

  1. 6.0
  2. 7
  3. 8
  4. 9
  5. 10
  6. 11
  7. 12
  8. 13

Author

Moshe Zadka, based on "pydoc --help"

From python3 3.13.5-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.