Differences between revisions 4 and 7 (spanning 3 versions)
Revision 4 as of 2003-10-07 04:29:19
Size: 1084
Editor: MikeRovner
Comment: wiki-link
Revision 7 as of 2005-10-25 16:13:51
Size: 1756
Editor: wlan236-232
Comment: Added Doxygen
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
 * PyDoc, http://web.pydoc.org/  * PyDoc, http://web.pydoc.org/ne documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$ ) fro
Line 6: Line 6:
 * PythonDoc - uses ReStructuredText input format, 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/  * 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. http://effbot.org/zone/pythondoc.htm
Line 10: Line 11:
 * 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.

Automatic Python API documentation generation tools:

Other projects that can be used to produce API documentation:

DocumentationTools (last edited 2019-07-03 12:34:58 by JaraKaca)

Unable to edit the page? See the FrontPage for instructions.