Pdoc
Jump to navigation
Jump to search
| pdoc | |
|---|---|
| Original author | Andrew Gallant |
| Developer | Mitmproxy Project |
| Initial release | August 9, 2013 |
| Repository | github |
| Written in | Python |
| Engine | |
| 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,[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
[edit | edit source]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 | edit source]Lua error in mw.title.lua at line 392: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal').