pdoc
API documentation generator for Python projects that renders modules, classes and functions from their docstrings and type annotations into HTML.
pdoc generates API documentation for Python projects. It imports the modules it is given, reads their docstrings and type annotations, and writes standalone HTML. The pdoc command includes a web server with live reloading, and the pdoc documentation describes its templates and options. The project is installed with pip and is maintained by Maximilian Hils.
Worth knowing
pdoc runs the code of the modules it documents, so those modules are imported on every run. The README recommends Sphinx for substantially more complex documentation needs and states that the project is not associated with the separate pdoc3 project.
Identity
Rendering and deploy
- Install with
- pip5
Releases
Adoption
Sources
- 2026-10-25: Written in, links, License, GitHub stars
api.github.com/repos/mitmproxy/pdoc - 2026-10-23: links
pdoc.dev/ - 2026-10-23: links, Templating
pdoc.dev/docs/pdoc.html - 2026-10-23: Maintainer, License model
raw.githubusercontent.com/mitmproxy/pdoc/main/LICENSE - 2026-10-23: Categories, Runtime, Minimum runtime, Install with
github.com/mitmproxy/pdoc/blob/main/README.md - 2026-10-23: Current major version, Last release, First release
pypi.org/pypi/pdoc/json - 2026-10-23: Contributors
api.github.com/repos/mitmproxy/pdoc/contributors?per_page=1 - 2026-10-25: Dependent repositories, Dependent packages, Downloads a month
packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc