Pdoc is a software package for generating

API An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how ...

documentation for Python

programming language A programming language is a system of notation for writing computer programs. Most programming languages are text-based formal languages, but they may also be graphical. They are a kind of computer language. The description of a programming l ...

. Built as a successor to

Epydoc Epydoc is a documentation generator that processes its own lightweight markup language Epytext for Python documentation strings. As opposed to freeform Python docstrings, reStructuredText (both also supported) and other markup languages for docs ...

, Pdoc uses

introspection Introspection is the examination of one's own Consciousness, conscious thoughts and feelings. In psychology, the process of introspection relies on the observation of one's Mental representation, mental state, while in a Spirituality, spiritual c ...

to extract documentation from source code docstrings and allows programmers to generate

HTML The HyperText Markup Language or HTML is the standard markup language for documents designed to be displayed in a web browser. It can be assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScri ...

documentation for chosen Python modules. It is thus functionally similar to

Pydoc Pydoc is the standard documentation module for the programming language Python. Similar to the functionality of Perldoc within Perl and Javadoc within Java, Pydoc allows Python programmers to access Python's documentation help files, generate text ...

, Perldoc and

Javadoc Javadoc (originally cased JavaDoc) is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code. The HTML format is used ...

. 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 la, furca 'pitchfork') is a utensil, now usually made of metal, whose long handle terminates in a head that branches into several narrow and often slightly curved tines with which one can spear foods eit ...

, such a
pdoc3
an
pdocs
part of th
portray
suite. As of 2021, the original pdoc project is active again.

References

{{Reflist

External links

Official websiteSoftware package on PyPI
Python (programming language) development tools Free documentation generators Free software programmed in Python

Forks

See also

References

External links