API Documentation
for Python Projects

pdoc auto-generates API documentation that follows your project's Python module hierarchy. It requires no configuration, has first-class support for type annotations, cross-links between identifiers, comes with an integrated live-reloading web server, and understands numpydoc or Google-style docstrings.

Installation

Latest Release: 15.0.4
 Documentation  Changelog
 PyPI  GitHub
" alt="Google" width="89" height="30" style="margin-top: 6px" loading="lazy" onerror="this.onerror=null,this.src='/assets/placeholder.svg'"> " alt="Microsoft" width="141" height="30" loading="lazy" onerror="this.onerror=null,this.src='/assets/placeholder.svg'"> Logo of Meta Platforms -- Graphic created by Detmar Owen" alt="Meta" width="110" height="22" loading="lazy" onerror="this.onerror=null,this.src='/assets/placeholder.svg'"> " alt="Mozilla" width="105" height="30" loading="lazy" onerror="this.onerror=null,this.src='/assets/placeholder.svg'"> " alt="Apache Software Foundation" width="100" height="41" loading="lazy" onerror="this.onerror=null,this.src='/assets/placeholder.svg'"> " alt="mitmproxy" width="132" height="30" loading="lazy" onerror="this.onerror=null,this.src='/assets/placeholder.svg'">
and many others use pdoc to document their Python projects.