mitmproxy/pdoc
API Documentation for Python Projects observed · 2026-08-28
Health v2 · maintenance only
73/100
- Activity 90
- Release rhythm 35
- Longevity 100
Flags: no_releases
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-09-03. Adoption (stars, forks) is never an input.
- gap_med: n/a
- age_days: 4777
- days_rel: n/a
- days_push: 63
- n_releases_24m: 0
Adoption not part of the score
2510 stars · 228 forks observed · 2026-08-28
What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded
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
cli-tool · maturity active
documentation api-documentation cli http-server documentation developer-tools apis python cli cross-platform docstring-rendering markdown-docs live-reload type-annotations html-generation python
4 sources
- readme: https://github.com/mitmproxy/pdoc · fetched 2026-08-28 · da7ea9f0bc25
- homepage: https://pdoc.dev · fetched 2026-08-29 · 154e623b78cb
- site_page: https://pdoc.dev/docs/pdoc.html · fetched 2026-08-29 · 96fce0518f2a
- registry_pypi: https://pypi.org/pypi/pdoc/json · fetched 2026-08-29 · 6f04c880297c
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| mitmproxy/pdoc | main | 73 |
For agents
Data as of 2026-08-30T08:39:29.467469+00:00 · Report a problem