Pdoc is a software package for generating
API
An application programming interface (API) is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build ...
documentation for
Python programming language
A programming language is a system of notation for writing computer programs.
Programming languages are described in terms of their Syntax (programming languages), syntax (form) and semantics (computer science), semantics (meaning), usually def ...
. Built as a successor to Epydoc, Pdoc uses
introspection
Introspection is the examination of one's own conscious thoughts and feelings. In psychology, the process of introspection relies on the observation of one's mental state, while in a spiritual context it may refer to the examination of one's s ...
to extract documentation from source code
docstrings and allows programmers to generate
HTML
Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. It defines the content and structure of web content. It is often assisted by technologies such as Cascading Style Sheets ( ...
documentation for chosen Python modules. It is thus functionally similar to
Pydoc,
Perldoc and
Javadoc
Javadoc (also capitalized as JavaDoc or javadoc) is an API documentation generator for the Java programming language. Based on information in Java source code, Javadoc generates documentation formatted as HTML and other formats via extensions. ...
. It supports identifier cross-linking and Markdown for its doc string format.
Forks
A lack of original project activity in 2018-2019 spurred several
forks
In cutlery or kitchenware, a fork (from 'pitchfork') is a Eating utensil, utensil, now usually made of metal, whose long handle terminates in a head that branches into several narrow and often slightly curved tine (structural), tines with whic ...
, such a
pdoc3an
pdocs part of th
portraysuite.
As of 2021, the original pdoc project is active again.
See also
*
Comparison of documentation generators
The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the s ...
References
{{Reflist
External links
Official websiteSoftware package on PyPI
Python (programming language) development tools
Free documentation generators
Free software programmed in Python