LinuxCommandLibrary

pydoc

TLDR

View module documentation

$ pydoc [module]
copy
Search documentation
$ pydoc -k [keyword]
copy
Start documentation server
$ pydoc -p [8080]
copy
Write documentation to file
$ pydoc -w [module]
copy
Browser mode
$ pydoc -b
copy

SYNOPSIS

pydoc [options] [module]

DESCRIPTION

pydoc displays Python documentation. Built-in help system.
The tool shows module docs. Generates HTML documentation.
pydoc shows Python help.

PARAMETERS

MODULE

Module to document.
-k KEYWORD
Search keyword.
-p PORT
Start HTTP server.
-w
Write HTML file.
-b
Open in browser.

CAVEATS

Built into Python. Uses docstrings.

HISTORY

pydoc is Python's built-in documentation viewer.

SEE ALSO

python(1), help(1), sphinx(1)

Copied to clipboard