pdoc
pdoc creates API documentation from Python projects and arranges it according to each project's module hierarchy.
What pdoc is
pdoc creates API documentation from Python projects and arranges it according to each project's module hierarchy. Its setup guidance says no configuration is required to begin. It produces standalone HTML that can be exported to files, and a built-in web server reloads the preview when source files change. pdoc supports Python type annotations and understands Markdown, numpydoc, and Google-style docstrings, with limited reStructuredText support. Generated HTML templates can be customized, and search runs in the browser without third-party services. Documentation can be deployed with GitHub Pages, and custom HTML fragments can be embedded in CMSs or static site generators. pdoc is free and open source, with Linux, macOS, Windows, web, and self-hosted options listed. It imports or executes the Python modules it documents. HTML is its only output format, and its main use is API documentation; Sphinx is recommended for substantially more complex documentation. pdoc supports Python 3.10 and newer.
Good
- No configuration is needed to get started.
- Supports Python type annotations.
- Live preview reloads when source files change.
- Search runs client-side without third-party services.
Watch out
- HTML is the only output format.
- Imports or executes documented Python modules.
- ReStructuredText support is limited.
Who it suits
pdoc is for Python project developers who want API documentation generated from code and docstrings. It can also suit developers who want a Python library interface or a live documentation preview.
Verdict
pdoc is focused on producing API documentation as HTML from Python code and docstrings. Its output and scope are narrow, so consider the stated Sphinx recommendation for substantially more complex documentation.
The facts
Each one read from pdoc's own pages, with the date it was checked.
What it does
- Customization
- Users can customize pdoc's HTML templates.checked 11 Oct 2026
- Docstring formats
- pdoc understands Markdown, numpydoc, and Google-style docstrings, with limited reStructuredText support.checked 4 Oct 2026
- Docstrings
- pdoc understands numpydoc and Google-style docstrings.checked 11 Oct 2026
- Dynamic analysis
- pdoc imports or executes Python modules while extracting docstrings.checked 4 Oct 2026
- Integrations
- The documentation says pdoc can be integrated with almost any CMS or static site generator, and gives GitHub Pages as an example.checked 11 Oct 2026
- Intended users
- The product is for Python project developers who want to generate API documentation from their code and docstrings.checked 4 Oct 2026
- Library use
- pdoc provides a high-level interface and can also be used as a Python library.checked 11 Oct 2026
- License
- The project repository lists the MIT-0 license.checked 11 Oct 2026
- Limit
- pdoc supports HTML output only and recommends Sphinx for substantially more complex documentation needs.checked 11 Oct 2026
- Live preview
- pdoc includes a web server with live reloading.checked 11 Oct 2026
- Maintenance
- The repository says pdoc was originally created by Andrew Gallant and is currently maintained by Maximilian Hils.checked 11 Oct 2026
- Output
- pdoc produces standalone HTML documentation files.checked 11 Oct 2026
- Output limitation
- pdoc supports HTML output only.checked 4 Oct 2026
- Purpose
- pdoc automatically generates API documentation that follows a Python project's module hierarchy.checked 11 Oct 2026
- Python requirement
- The project states that pdoc is compatible with Python 3.10 and newer.checked 11 Oct 2026
- Runtime behavior
- pdoc uses dynamic analysis, so it executes or imports the Python modules being documented.checked 11 Oct 2026
- Scope
- The documentation identifies API documentation as pdoc's main use case and recommends Sphinx for substantially more complex documentation needs.checked 4 Oct 2026
- Search
- Generated documentation search runs client-side and does not require third-party services.checked 4 Oct 2026
- Setup
- pdoc says it requires no configuration for basic use.checked 11 Oct 2026
- Type annotations
- pdoc has first-class support for Python type annotations and automatically links documented identifiers.checked 11 Oct 2026
