pdoc
pdoc.dev
- Free plan
- Windows
- macOS
- Linux
- Web
- Self-hosted
What pdoc is
pdoc is free, open-source software that generates API documentation from Python projects. It organizes pages around a project’s module hierarchy and requires no configuration to begin. The output is standalone HTML that can be exported, and a built-in web server reloads the preview when source files change. pdoc supports Python type annotations and recognizes Markdown, numpydoc, and Google-style docstrings, with limited reStructuredText support. Generated HTML templates can be customized. Search runs in the browser without third-party services. Documentation can be deployed with GitHub Pages or embedded as custom HTML fragments in CMSs and static site generators. pdoc is available for Linux, macOS, Windows, web, and self-hosted use, and can also be used as a Python library. It supports Python 3.10 and newer, imports or executes documented modules, and produces HTML only.
Who it suits
pdoc suits Python developers who want API reference pages generated from code and docstrings. It is aimed at API documentation rather than substantially more complex documentation projects.
Good to know, and what to watch
- No configuration needed to start
- Live preview reloads on source changes
- Supports Python type annotations
- Customizable HTML templates
- Client-side search needs no third party
- HTML is the only output format
- Dynamic analysis executes or imports modules
- Limited reStructuredText support
- Complex documentation may need Sphinx
The verdict
pdoc offers a focused way to turn Python modules and docstrings into browsable HTML API documentation. Its live preview, customization, and deployment options are useful, but its scope and output format are deliberately narrow.
What the maker publishes
- Customization
- Users can customize the generated HTML templates. source
- Customization
- Users can customize pdoc's HTML templates. source
- Docstring formats
- pdoc understands Markdown, numpydoc, and Google-style docstrings, with limited reStructuredText support. source
- Docstrings
- pdoc understands numpydoc and Google-style docstrings. source
- Dynamic analysis
- pdoc imports or executes Python modules while extracting docstrings. source
- Integrations
- The documentation describes deployment with GitHub Pages and says custom HTML fragments can be embedded in CMSs or static site generators. source
- Integrations
- The documentation says pdoc can be integrated with almost any CMS or static site generator, and gives GitHub Pages as an example. source
- Intended users
- The product is for Python project developers who want to generate API documentation from their code and docstrings. source
- Library use
- pdoc provides a high-level interface and can also be used as a Python library. source
- License
- The project repository lists the MIT-0 license. source
- Limit
- pdoc supports HTML output only and recommends Sphinx for substantially more complex documentation needs. source
- Live preview
- Its built-in web server reloads the documentation when the source file changes. source
- Live preview
- pdoc includes a web server with live reloading. source
- Maintenance
- The repository says pdoc was originally created by Andrew Gallant and is currently maintained by Maximilian Hils. source
- Output
- pdoc generates standalone HTML documentation that can be exported to files. source
- Output
- pdoc produces standalone HTML documentation files. source
- Output limitation
- pdoc supports HTML output only. source
- Purpose
- pdoc auto-generates API documentation that follows a Python project's module hierarchy. source
- Purpose
- pdoc automatically generates API documentation that follows a Python project's module hierarchy. source
- Python requirement
- The project states that pdoc is compatible with Python 3.10 and newer. source
- Runtime behavior
- pdoc uses dynamic analysis, so it executes or imports the Python modules being documented. source
- Scope
- The documentation identifies API documentation as pdoc's main use case and recommends Sphinx for substantially more complex documentation needs. source
- Search
- Generated documentation search runs client-side and does not require third-party services. source
- Setup
- The documentation says pdoc needs no configuration to get started. source
Checked against the maker's pages on 11 Oct 2026.