Pdoc Explained

pdoc
Author:	Andrew Gallant
Developer:	Mitmproxy Project
Programming Language:	Python
Operating System:	Cross-platform
Genre:	Documentation generator
License:	Public Domain (UNLICENSE)

Pdoc is a software package for generating API documentation for Python programming language. Built as a successor to Epydoc,^[1] 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.^[2]

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

• Comparison of documentation generators

External links

• Official website
• Software package on PyPI

Notes and References

1. Web site: r/Python - pdoc is a documentation generator to replace epydoc (it comes with an HTTP server that supports automatic cross linking between modules). reddit. en. 2019-01-12.
2. Web site: pdoc README. github.com. 2020-05-11.