What does it do?
pdoc reads the comments already sitting inside a Python program, the docstrings developers write to explain what a function does, and automatically generates a clean reference website from them with zero configuration. It’s the just-work alternative to Sphinx: run one command in a project folder and get a browsable set of pages listing every module, class, and function. There’s no templating language to learn and no build pipeline to maintain. It even includes a built-in live server so you can preview the site as you write more docstrings.
See it in action
This is a single terminal command that reads the explanatory notes already written inside your code and instantly builds a browsable reference website from them.
pdoc your_package
# opens a live-reloading documentation site at http://localhost:8080Why would a non-developer care?
Plenty of small, useful open source tools never get proper documentation because writing it feels like a whole separate project on top of writing the code. pdoc removes most of that excuse, which means more of the free software you rely on ends up with usable reference docs instead of none at all.
Real-world examples
Countless small-to-medium Python packages on PyPI ship pdoc-generated reference pages linked straight from their README, because setup takes minutes rather than days. It’s the tool a solo maintainer reaches for late at night when they finally decide their project needs at least something for documentation.
Who uses it
Individual developers and small teams who want auto-generated API reference docs without configuring a full documentation system.
How it compares to alternatives
pdoc deliberately does less than Sphinx, no custom themes, no complex cross-project linking, no PDF export, in exchange for needing almost no setup, making it a more direct rival to Python’s built-in pydoc module, which it’s named after and considerably improves on.