Jump to content

Pdoc

Add links
From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by BurntSushi (talk | contribs) at 18:08, 11 May 2020 (pdoc3 is a hostfile fork of pdoc, and is a different piece of software. This revision updates the article to identify the correct location and license of the project.). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

This article is about computer software. For PetroDar Operating Company, see PetroDar.
pdoc
Original author(s)Andrew Gallant
Developer(s)Mitmproxy Project
Initial releaseAugust 9, 2013; 11 years ago (2013-08-09)
Stable release
0.3.2 / March 23, 2016; 8 years ago (2016-03-23)
Repositorygithub.com/mitmproxy/pdoc
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicensePublic Domain (UNLICENSE)
Websitegithub.com/mitmproxy/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 plain text, Markdown or 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]

See also

References

  1. ^ "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.
  2. ^ "pdoc README". github.com. Retrieved 2020-05-11.{{cite web}}: CS1 maint: url-status (link)
Retrieved from "https://en.wikipedia.org/w/index.php?title=Pdoc&oldid=956138433"