Epydoc

Epydoc

Epydoc is a documentation generator that renders its own lightweight markup language Epytext for Python documentation strings. As opposed to freeform Python docstrings, reStructured Text (both also supported) and other markup languages for docstrings, Epytext supports linking between different pieces of documentation.

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.

ee also

*Comparison of documentation generators

External links

* [http://epydoc.sourceforge.net/ Epydoc website]


Wikimedia Foundation. 2010.

Игры ⚽ Поможем решить контрольную работу

Look at other dictionaries:

  • Epydoc — Тип Генератор документации Разработчик Эдуард Лопер и др. Операционная система Любая, где работает Python Последняя версия 3.0.1 (30 января 2008) Лицензия Лицензия MIT Сайт …   Википедия

  • 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. This article is not all inclusive or necessarily up to date. Unless… …   Wikipedia

  • Anexo:Comparativa de generadores de documentación — Las siguientes tablas comparan información general y técnica de un número de generadores de documentación. Por favor, consulte la página individual de cada producto para obtener información adicional. Este artículo no incluye todos los… …   Wikipedia Español

  • Doctest — is a module included in the Python programming language s standard library that allows the easy generation of tests based on output from the standard Python interpreter shell, cut and pasted into docstrings.Implementation specificsdoctest makes… …   Wikipedia

  • Docstring — In programming, a docstring is a string literal specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, or even specifically formatted comments like Javadoc… …   Wikipedia

  • Генератор документации — Генератор документации  программа или пакет программ, позволяющая получать документацию, предназначенную для программистов (документация на API) и/или для конечных пользователей системы, по особым образом комментированному исходному коду и,… …   Википедия

  • Javadoc — Тип Генератор документации Разработчик Sun Microsystems Операционная система кроссплатформенная Последняя версия 1.50 Лицензия GNU GPL 2 + «Classpath exception»[1] …   Википедия

  • doctest — is a module included in the Python programming language s standard library that allows the easy generation of tests based on output from the standard Python interpreter shell, cut and pasted into docstrings. Contents 1 Implementation specifics 2… …   Wikipedia

  • Vereinfachte Auszeichnungssprache — Eine Vereinfachte Auszeichnungssprache ist eine Auszeichnungssprache mit einer einfachen Syntax, um Dokumente einfach manuell erstellen und lesen zu können. Meist werden Dokumente für die endgültige Darstellung in eine gewöhnliche… …   Deutsch Wikipedia

  • Web2py — Développeurs Massimo Di Pierro et contributeurs …   Wikipédia en Français

Share the article and excerpts

Direct link
… Do a right-click on the link above
and select “Copy Link”