Pdoc

Summary

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 releaseAugust 9, 2013; 10 years ago (2013-08-09)
Stable release
14.4.0[1] Edit this on Wikidata / 17 January 2024; 2 months ago (17 January 2024)
Repositorygithub.com/mitmproxy/pdoc
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicensePublic Domain (UNLICENSE)
Websitepdoc.dev

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

  1. ^ "Release 14.4.0". 17 January 2024. Retrieved 19 January 2024.
  2. ^ "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.
  3. ^ "pdoc README". github.com. Retrieved 2020-05-11.

External links edit

  • Official website
  • Software package on PyPI