pydoc
View Python module documentation
TLDR
View module documentation
SYNOPSIS
pydoc [options] [module]
DESCRIPTION
pydoc is Python's built-in documentation tool that displays module documentation generated from docstrings and introspection. It can show documentation for modules, classes, functions, and keywords in the terminal, search across all installed modules with -k, or generate static HTML files with -w.
The -p flag starts a local HTTP documentation server that provides a browsable interface to all installed Python modules, and -b opens this server automatically in the default web browser. pydoc is part of the Python standard library and provides the same functionality as the interactive help() function.
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.
