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

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

External links


This article is issued from Wikipedia - version of the 4/12/2016. The text is available under the Creative Commons Attribution/Share Alike but additional terms may apply for the media files.