# pdoc

API documentation generator for Python projects that renders modules, classes and functions from their docstrings and type annotations into HTML.


Source: https://findsoftware.frbit.cloud/pdoc/
Last reviewed: 2026-10-23
Updated: 2026-10-25
Listed since: 2026-10-23

## Record

### Links

- home: https://pdoc.dev
- repository: https://github.com/mitmproxy/pdoc
- docs: https://pdoc.dev/docs/pdoc.html

### Identity

- status: active
- maintainer: Maximilian Hils
- maintainerType: unknown
- parent: unknown
- firstRelease: 2013
- hqCountry: unknown

### Kind

- category: ssg
- hosting: python
- language: python
- runtime: python
- runtimeMin: python 3.10
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: jinja2
- i18n: unknown

### Rendering and deploy

- runsAs: unknown
- renderingModes: unknown
- installMethod: pip

### License

- licenseModel: open-source
- license: MIT-0

### Releases

- currentMajor: 16
- latestReleaseDate: 2025-10-27

### Adoption

- githubStargazers: 2519
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 62
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: 1496003
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 388
- dependentPackages: 192

### Sources

- language: https://api.github.com/repos/mitmproxy/pdoc (read 2026-10-25)
- urls: https://pdoc.dev/ (read 2026-10-23)
- urls: https://api.github.com/repos/mitmproxy/pdoc (read 2026-10-23)
- urls: https://pdoc.dev/docs/pdoc.html (read 2026-10-23)
- maintainer: https://raw.githubusercontent.com/mitmproxy/pdoc/main/LICENSE (read 2026-10-23)
- category: https://github.com/mitmproxy/pdoc/blob/main/README.md (read 2026-10-23)
- runtime: https://github.com/mitmproxy/pdoc/blob/main/README.md (read 2026-10-23)
- runtimeMin: https://github.com/mitmproxy/pdoc/blob/main/README.md (read 2026-10-23)
- installMethod: https://github.com/mitmproxy/pdoc/blob/main/README.md (read 2026-10-23)
- templating: https://pdoc.dev/docs/pdoc.html (read 2026-10-23)
- license: https://api.github.com/repos/mitmproxy/pdoc (read 2026-10-23)
- licenseModel: https://raw.githubusercontent.com/mitmproxy/pdoc/main/LICENSE (read 2026-10-23)
- currentMajor: https://pypi.org/pypi/pdoc/json (read 2026-10-23)
- latestReleaseDate: https://pypi.org/pypi/pdoc/json (read 2026-10-23)
- firstRelease: https://pypi.org/pypi/pdoc/json (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/mitmproxy/pdoc (read 2026-10-23)
- contributors: https://api.github.com/repos/mitmproxy/pdoc/contributors?per_page=1 (read 2026-10-23)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc (read 2026-10-25)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc (read 2026-10-25)
- ecosystemsMonthlyDownloads: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc (read 2026-10-25)

## Notes

pdoc generates API documentation for Python projects. It imports the modules it is given, reads their docstrings and type annotations, and writes standalone HTML. The pdoc command includes a web server with live reloading, and the [pdoc documentation](https://pdoc.dev/docs/pdoc.html) describes its templates and options. The project is installed with pip and is maintained by Maximilian Hils.

## Worth knowing

pdoc runs the code of the modules it documents, so those modules are imported on every run. The README recommends Sphinx for substantially more complex documentation needs and states that the project is not associated with the separate pdoc3 project.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0