pdoc3/pdoc
Some data may be outdated — see provenance labels.
🐍 ➡️ 📜 Auto-generate API docs for Python projects observed · 2026-09-25
Health v2 · maintenance only
63/100
- Activity 89
- Release rhythm 8
- Longevity 100
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-10-21. Adoption (stars, forks) is never an input.
- gap_med: n/a
- age_days: 2849
- days_rel: n/a
- days_push: 66
- n_releases_24m: 0
Adoption not part of the score
1182 stars · 146 forks observed · 2026-09-25
What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded
pdoc3 is a Python tool that auto-generates API documentation from a project's modules, classes, functions, and their docstrings with zero configuration. It supports common docstring formats (Markdown, numpydoc, Google-style), type annotations, cross-linking, customizable Mako templates, and includes a built-in development web server for live preview.
Use cases
- generate api docs for my python package from docstrings
- lightweight sphinx alternative for python documentation
- auto-generate html documentation from python source code
- preview python docstrings in a local web server
- document python project with markdown docstrings
- create api reference docs with zero configuration
When to choose
- you have a small-to-medium Python project and want docs with minimal setup
- you prefer Markdown or Google/numpydoc docstring styles over reST
- you want automatic cross-linking and docstring inheritance out of the box
- you need customizable HTML templates via Mako
When to avoid
- you need Sphinx's full ecosystem of extensions, themes, and multi-format output
- your project is large and requires fine-grained documentation control
- you cannot accept the AGPL-3.0 license
- you need documentation for non-Python code
Facets
cli-tool · maturity active
documentation api-documentation cli templating documentation developer-tools python cli cross-platform docstring-parsing api-docs markdown sphinx-alternative mako-templates python
2 sources
- readme: https://github.com/pdoc3/pdoc · fetched 2026-09-25 · c8d1473244da
- homepage: https://pdoc3.github.io/pdoc/ · fetched 2026-08-29 · 82339878745a
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| pdoc3/pdoc | main | 63 |
For agents
Data as of 2026-10-19T08:05:51.212177+00:00 · Report a problem