Automatic Python API documentation generation tools:

Edit conflict - other version:

• PyDoc, http://pydoc.org/ documentation browser (in HTML) and/or an off-line reference manual. Also in the standard library as [http://docs.python.org/lib/module-pydoc.html pydoc]

Edit conflict - your version:

• PyDoc, http://pydoc.org/ documentation browser (in HTML) and/or an off-line reference manual. Also in the standard library as [http://docs.python.org/lib/module-pydoc.html pydoc]

End of edit conflict

• DocUtils, http://docutils.sourceforge.net/ ReStructuredText processing engine

• EpyDoc, http://epydoc.sourceforge.net/

• HappyDoc, http://happydoc.sourceforge.net/

• PythonDoc - uses StructuredText input format (not reST), and can produce HTML and XML output. It uses XML as an intermediate representation, to simplify the addition of new output formats. http://starship.python.net/crew/danilo/pythondoc/

• Another PythonDoc - uses JavaDoc-style comments, and produces HTML and XML output. Can also be used as a library, producing ElementTree descriptions of your source code. http://effbot.org/zone/pythondoc.htm

• ["Crystal"] - produces output that is similar to JavaDoc.

• EasyDoc - uses an HTML-like markup language, similar to the language used by JavaDoc; and produces HTML output (http://htmltmpl.sourceforge.net/easydoc.html)

• ["Teud"], TeudProject

• Doxygen < http://www.doxygen.org > can create documentation in various formats (HTML, LaTeX, PDF, ...) and you can include formulas in your documentation (great for technical/mathematical software). Together with Graphviz < http://www.research.att.com/sw/tools/graphviz/ > it can create diagrams of your code (inhertance diagram, call graph, ...). Another benefit is that it handles not only Python, but also several other programming languages like C, C++, Java, etc.

• Pudge, http://pudge.lesscode.org/

• Endo, part of the Enthought Tool Suite (http://code.enthought.com/ets/), is aware of Traits-based attributes (Traits is also part of ETS); uses ReStructuredText or plain text in docstrings and in plain comments that immediately precede variable assignments; and generates HTML output.

Other projects that can be used to produce API documentation:

• [http://www.livinglogic.de/Python/xist/index.html XIST] - an XML based extensible HTML generator written in Python.

• [http://starship.python.net/crew/friedrich/HTMLgen/html/main.html HtmlGen] - a Python library for generating HTML documents.