pdoc

5.2easy start · #28 of 28
in API Documentation Tools

Runs on Linux, Mac, self-hosted, Web, Windows.

pdoc is ranked #28 of 28 in API documentation tools on The Geeks Club. It runs on Linux, macOS, Self-hosted, Web, Windows.

Compared on API documentation tools

PilotDocs 0 of 4 in the starter kit Lesson 17.7 ApiNotes 0 of 4 in the starter kit Lesson 27.6 Scalar 0 of 4 in the starter kit Lesson 37.5 Javadoc 0 of 4 in the starter kit Lesson 47.2 Doxygen 0 of 4 in the starter kit Lesson 57.1 Palt 0 of 4 in the starter kit Lesson 67.1

Purpose: pdoc auto-generates API documentation that follows a Python project's module hierarchy.
Setup: The documentation says pdoc needs no configuration to get started.
Output: pdoc generates standalone HTML documentation that can be exported to files.
Live preview: Its built-in web server reloads the documentation when the source file changes.
Type annotations: pdoc has first-class support for Python type annotations.
Docstring formats: pdoc understands Markdown, numpydoc, and Google-style docstrings, with limited reStructuredText support.
Customization: Users can customize the generated HTML templates.
Integrations: The documentation describes deployment with GitHub Pages and says custom HTML fragments can be embedded in CMSs or static site generators.
Search: Generated documentation search runs client-side and does not require third-party services.
Dynamic analysis: pdoc imports or executes Python modules while extracting docstrings.
Output limitation: pdoc supports HTML output only.
Scope: The documentation identifies API documentation as pdoc's main use case and recommends Sphinx for substantially more complex documentation needs.
Intended users: The product is for Python project developers who want to generate API documentation from their code and docstrings.

Claim it for free: prove the domain, then correct facts, plans and screenshots. An editor reviews every change.