pdoc3
Auto-generate API documentation for Python projects.
Decision gist · record as of 2026-08-14
Yes, if you need straightforward API documentation for Python 3.9+ projects and accept AGPL-3.0 licensing. The low install friction, active maintenance, and zero known vulnerabilities make it reliable. The AGPL copyleft license is the main consideration: if your project or use case requires permissive licensing, this is not suitable; otherwise, it's a solid choice for minimal-configuration documentation generation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later.
- Low install friction with only two runtime dependencies (mako and markdown).
- Actively maintained with recent commits and a stable production status.
License · maintenance · safety
AGPL-3.0 (agpl) — Licensed under AGPL-3.0, which requires that any modifications or derivative works be distributed under the same license and that source code be made available to users. This is a copyleft license with stronger obligations than permissive alternatives.
last release 2025-03-20 (512 days) · last repo commit 2026-07-20 · 1,188 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 290,724 downloads/mo, #7,983 on PyPI
Alternatives
Verify before relying
$ pip install pdoc3
$ pdoc your_project
Or in Python:
import pdoc
pdoc.pdoc('your_module')- Whether the built-in development web server supports live-reload or auto-refresh during documentation preview.
- Performance characteristics when documenting very large projects or deeply nested package hierarchies.
- Whether cross-linking works across multiple separate projects or only within a single module/package.
What it is and what it does
pdoc3 is a command-line tool and Python library that reads your Python source code and generates formatted API documentation without requiring configuration files or special markup. It parses docstrings in Markdown, numpydoc, and Google-style formats, respects type annotations from PEP 484 and PEP 526, and automatically cross-links referenced identifiers within the documentation.
The tool is designed for minimal setup: point it at a module, package, or import path and it produces browsable HTML documentation. It includes a built-in development web server for previewing changes, supports customizable templates for advanced users, and respects Python conventions like `__all__` and docstring inheritance. It handles both module-level and instance variables by traversing abstract syntax trees.
Use it for
- Generate API documentation for open-source Python packages without maintaining separate doc configuration or build steps.
- Create quick reference documentation during development using the built-in web server for instant preview.
- Document internal Python projects where minimal configuration and automatic cross-linking reduce maintenance overhead.
- Support multiple docstring formats (Markdown, Google-style, numpydoc) across a mixed codebase without reformatting.
- Publish type-annotated API docs that automatically reflect PEP 484 and PEP 526 type information from source.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need straightforward API documentation for Python 3.9+ projects and accept AGPL-3.0 licensing.
The low install friction, active maintenance, and zero known vulnerabilities make it reliable. The AGPL copyleft license is the main consideration: if your project or use case requires permissive licensing, this is not suitable; otherwise, it's a solid choice for minimal-configuration documentation generation.
Install
pdoc3 on PyPI
Before you install
Low install friction with only two runtime dependencies (mako and markdown). Actively maintained with recent commits and a stable production status.
Requires Python 3.9 or later.
License in practice
Licensed under AGPL-3.0, which requires that any modifications or derivative works be distributed under the same license and that source code be made available to users. This is a copyleft license with stronger obligations than permissive alternatives.
Quickstart
$ pip install pdoc3
$ pdoc your_project
Or in Python:
import pdoc
pdoc.pdoc('your_module')Verify before relying
- Whether the built-in development web server supports live-reload or auto-refresh during documentation preview.
- Performance characteristics when documenting very large projects or deeply nested package hierarchies.
- Whether cross-linking works across multiple separate projects or only within a single module/package.
Package facts
| License | AGPL-3.0 agpl |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesmakomarkdown |
| Maintenance | Actively maintained 512 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 290,724 / month, #7,983 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleIntended Audience :: DevelopersLicense :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)Operating System :: OS IndependentProgramming Language :: Python :: 3 :: OnlyTopic :: DocumentationTopic :: Software Development :: DocumentationTopic :: Utilities |
Evidence: pdoc3-0.11.6-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “automatic documentation from code”
- pdoc3Generates API documentation for Python 3+ projects automatically from…
- SphinxSphinx generates professional documentation from reStructuredText…
- mkdocstringsAn MkDocs plugin that automatically generates API documentation from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also pdoc · mkdocstrings-python · quartodoc · pydoctor · mkdocstrings-python-legacy · numpydoc · pydocstringformatter · docstring-parser · sphinx-autodoc2 · docformatter