Jump to content

Epydoc

From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by JJMC89 bot III (talk | contribs) at 21:17, 21 September 2020 (Moving Category:Python software to Category:Python (programming language) software per Wikipedia:Categories for discussion/Speedy). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

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 docstrings, Epytext supports linking between different pieces of documentation. The project Epydoc is inactive since February 2009. Epydoc is released under the MIT license.

There are several tools for rendering Epytext. Most commonly, the epydoc program is used to render Epytext as a series of HTML documents for display on the Internet, or as a PDF document for printing. Epydoc also supports viewing the rendered documentation within Python using a GUI. The syntax is uncomplicated enough for the programmer to read the raw Epytext docstrings embedded in the source code directly.

See also