# mitmproxy/pdoc

API Documentation for Python Projects

Repository: https://github.com/mitmproxy/pdoc
Canonical: https://ross.abutalabs.com/products/pdoc
Homepage: https://pdoc.dev
Language: Python
License: MIT-0
License Family: permissive
Topics: documentation, python, docstrings, docs, pdoc, api-documentation, python3, api, docstring, documentation-tool, documentation-generator
Last push: 2026-07-01T08:04:25+00:00

## Health v2 (maintenance only)
Score: 73/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 90, release rhythm 35, longevity 100
- inputs: {"age_days": 4777, "days_push": 63, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2510, forks 228 (observed 2026-08-28T04:06:57.344454+00:00)

## What it is
pdoc is a zero-configuration documentation generator that auto-generates API documentation for Python projects from docstrings and type annotations. It renders Markdown docstrings into HTML, supports numpydoc and Google-style docstrings, and includes a live-reloading web server for previewing docs.

## Use cases
- generate api documentation for a python package
- render docstrings as html docs
- document a python library with type annotations
- preview python docs with live reload
- export python api docs to static html for github pages
- convert google-style or numpydoc docstrings to documentation

## When to choose
- you want zero-config API docs for a Python project
- your docstrings are Markdown, Google-style, or numpydoc
- you want first-class type annotation support and cross-linking
- you need a live-reloading docs preview server

## When to avoid
- you need multi-language documentation beyond Python
- you want a full docs site with tutorials and guides (consider MkDocs or Sphinx)
- you need reStructuredText docstring support

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, api-documentation, cli, http-server
- domain: documentation, developer-tools, apis
- platform: python, cli, cross-platform
- tags: docstring-rendering, markdown-docs, live-reload, type-annotations, html-generation, python

## Member repositories
- mitmproxy/pdoc (main) score 73

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:57.344454+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:26:26.422834+00:00, confidence not recorded.
  - readme: https://github.com/mitmproxy/pdoc (fetched 2026-08-28T04:06:57.344454+00:00, sha da7ea9f0bc25)
  - homepage: https://pdoc.dev (fetched 2026-08-29T10:08:55.147319+00:00, sha 154e623b78cb)
  - site_page: https://pdoc.dev/docs/pdoc.html (fetched 2026-08-29T10:08:55.178062+00:00, sha 96fce0518f2a)
  - registry_pypi: https://pypi.org/pypi/pdoc/json (fetched 2026-08-29T10:08:55.182031+00:00, sha 6f04c880297c)
- Data as of 2026-08-30T08:39:29.467469+00:00.