168
Comment:
|
1187
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
Automatic documentation generation tools: | Automatic Python API documentation generation tools: * PyDoc, http://web.pydoc.org/ * DocUtils, http://docutils.sourceforge.net/ ReStructuredText processing engine |
Line 4: | Line 6: |
* PyDoc, http://web.pydoc.org/ | * 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 * ["Crystal"] - produces output that is similar to Wiki:JavaDoc. * EasyDoc - uses an HTML-like markup language, similar to the language used by Wiki:JavaDoc; and produces HTML output (http://htmltmpl.sourceforge.net/easydoc.html) * ["Teud"], EfnetPythonWiki:TeudProject |
Line 6: | Line 12: |
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. |
Automatic Python API documentation generation tools:
DocUtils, http://docutils.sourceforge.net/ ReStructuredText processing engine
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
["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
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.