Pdoc

For other uses, see PDOC.

Pdoc is a software package for generating API documentation for Python programming language. Built as a successor to Epydoc,^[2] Pdoc uses introspection to extract documentation from source code docstrings and allows programmers to generate HTML documentation for chosen Python modules. It is thus functionally similar to Pydoc, Perldoc and Javadoc. It supports identifier cross-linking and Markdown for its doc string format.^[3]

pdoc

Original author(s)	Andrew Gallant
Developer(s)	Mitmproxy Project
Initial release	August 9, 2013; 11 years ago (2013-08-09)
Stable release	15.0.1[1]  / 12 December 2024; 4 months ago (12 December 2024)
Repository	github.com/mitmproxy/pdoc
Written in	Python
Operating system	Cross-platform
Type	Documentation generator
License	Public Domain (UNLICENSE)
Website	pdoc.dev

Forks

A lack of original project activity in 2018-2019 spurred several forks, such as pdoc3 and pdocs, part of the portray suite.

As of 2021, the original pdoc project is active again.

See also

• Free and open-source software portal

• Comparison of documentation generators