Pdoc
 | |
| Original author(s) | Andrew Gallant |
|---|---|
| Developer(s) | Mitmproxy Project |
| Initial release | August 9, 2013 |
| Stable release | 15.0.0[1] 
/ 11 October 2024 |
| Repository | github |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | Public Domain (UNLICENSE) |
| Website | 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]
Forks
[edit]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
[edit]
References
[edit]- ^ "Release 15.0.0". 11 October 2024. Retrieved 23 October 2024.
- ^ "r/Python - pdoc is a documentation generator to replace epydoc (it comes with an HTTP server that supports automatic cross linking between modules)". reddit. Retrieved 2019-01-12.
- ^ "pdoc README". github.com. Retrieved 2020-05-11.