Wikipedia

Pdoc

Also found in: Acronyms.
This article is about computer software. For PetroDar Operating Company, see PetroDar.
pdoc
Pdoc logo
Original author(s)Andrew Gallant
Developer(s)Mitmproxy Project
Initial releaseAugust 9, 2013
Stable release
1.0.0 / January 19, 2021 (2021-01-19)
Repositorygithub.com/mitmproxy/pdoc
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicensePublic Domain (UNLICENSE)
Websitepdoc.dev

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

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.

External links

This article is copied from an article on Wikipedia® - the free encyclopedia created and edited by its online user community. The text was not checked or edited by anyone on our staff. Although the vast majority of Wikipedia® encyclopedia articles provide accurate and timely information, please do not assume the accuracy of any particular article. This article is distributed under the terms of GNU Free Documentation License.

Copyright © 2003-2025 Farlex, Inc Disclaimer
All content on this website, including dictionary, thesaurus, literature, geography, and other reference data is for informational purposes only. This information should not be considered complete, up to date, and is not intended to be used in place of a visit, consultation, or advice of a legal, medical, or any other professional.