{% autoescape false %}{% filter replace("\n","") | replace(" ","") | replace(" { "@context": "https://schema.org", "@type": "SoftwareApplication", "name": "pdoc", "operatingSystem": "Python 3", "applicationCategory": "DeveloperApplication", "sameAs": [ "https://www.google.com/search?kgmid=/g/11g_rlj66_", "https://en.wikipedia.org/wiki/Pdoc", "https://github.com/mitmproxy/pdoc", "https://pypi.org/project/pdoc/" ], "offers": { "@type": "Offer", "price": "0", "priceCurrency": "USD" }, "review": { "@type": "Review", "reviewRating": { "@type": "Rating", "ratingValue": "5" }, "author": { "@type": "Person", "name": "Maximilian Hils", "sameAs": "https://hi.ls/" }, "reviewBody": "A lightweight alternative to Sphinx!" }, "thumbnailUrl": "https://pdoc.dev/favicon.svg", "image": "https://pdoc.dev/logo.svg", "url": "https://pdoc.dev/", "aggregateRating": { "@type": "AggregateRating", "ratingValue": "4.9", "ratingCount": "855"{# github stars, update occasionally #} } } {% endfilter %}{% endautoescape %} {%- macro icon(name) -%} {% autoescape false %} {% filter replace('
{% include "logo.svg" %}

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: {{ __version__ }}
{{ icon("book-half") }}  Documentation {{ icon("newspaper") }}  Changelog
{{ icon("box-seam") }}  PyPI {{ icon("github") }}  GitHub
Google Microsoft Meta Mozilla Apache Software Foundation mitmproxy
and many others use pdoc to document their Python projects.