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. 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

• Comparison of documentation generators

External links

• Epydoc website

This article "Epydoc" is from Wikipedia. The list of its authors can be seen in its historical and/or the page Edithistory:Epydoc. Articles copied from Draft Namespace on Wikipedia could be seen on the Draft Namespace of Wikipedia and not main one.

📰 Article(s) of the same category(ies)

• Naaya
• Poezio
• Ddoc
• Python SCOOP (software)
• PyScripter
• Nagare (web framework)
• Grok (web framework)

---