On the recordRead 11 Oct 202620 facts
pdoc
On the record
- Customization
- Users can customize pdoc's HTML templates.pdoc.dev · read 11 Oct 2026
- Docstring formats
- pdoc understands Markdown, numpydoc, and Google-style docstrings, with limited reStructuredText support.pdoc.dev · read 4 Oct 2026
- Docstrings
- pdoc understands numpydoc and Google-style docstrings.pdoc.dev · read 11 Oct 2026
- Dynamic analysis
- pdoc imports or executes Python modules while extracting docstrings.pdoc.dev · read 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.pdoc.dev · read 11 Oct 2026
- Intended users
- The product is for Python project developers who want to generate API documentation from their code and docstrings.pdoc.dev · read 4 Oct 2026
- Library use
- pdoc provides a high-level interface and can also be used as a Python library.pdoc.dev · read 11 Oct 2026
- License
- The project repository lists the MIT-0 license.github.com · read 11 Oct 2026
- Limit
- pdoc supports HTML output only and recommends Sphinx for substantially more complex documentation needs.pdoc.dev · read 11 Oct 2026
- Live preview
- pdoc includes a web server with live reloading.pdoc.dev · read 11 Oct 2026
- Maintenance
- The repository says pdoc was originally created by Andrew Gallant and is currently maintained by Maximilian Hils.github.com · read 11 Oct 2026
- Output
- pdoc produces standalone HTML documentation files.pdoc.dev · read 11 Oct 2026
- Output limitation
- pdoc supports HTML output only.pdoc.dev · read 4 Oct 2026
- Purpose
- pdoc automatically generates API documentation that follows a Python project's module hierarchy.pdoc.dev · read 11 Oct 2026
- Python requirement
- The project states that pdoc is compatible with Python 3.10 and newer.github.com · read 11 Oct 2026
- Runtime behavior
- pdoc uses dynamic analysis, so it executes or imports the Python modules being documented.pdoc.dev · read 11 Oct 2026
- Scope
- The documentation identifies API documentation as pdoc's main use case and recommends Sphinx for substantially more complex documentation needs.pdoc.dev · read 4 Oct 2026
- Search
- Generated documentation search runs client-side and does not require third-party services.pdoc.dev · read 4 Oct 2026
