Differences between revisions 3 and 43 (spanning 40 versions)
Revision 3 as of 2003-10-06 21:47:54
Size: 1125
Editor: MikeRovner
Comment:
Revision 43 as of 2019-05-06 21:11:36
Size: 5316
Editor: JaraKaca
Comment: Revise pdoc3 description. Thanks.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Automatic Python API documentation generation tools:
 * PyDoc, http://web.pydoc.org/
 * DocUtils, http://docutils.sourceforge.net/ ReStructuredText processing engine
This page is primarily about tools that help, specifically, in generating '''documentation for software written in Python''',
i.e., tools that can use language-specific features to automate at least a part of the code documentation work for you.
The last section also lists general documentation tools with no specific support for Python (though some of them are themselves written in Python).

Tools that support auto-documentation of code can be broadly classified into tools that:

 * import the code to generate documentation based on runtime introspection
 
 * parse and analyze the code statically (without running it)
 
See [[API Extraction|here]] for a longer explanation of the two concepts.

Tools that generate documentation from user-provided input typically use plain text markup formats such as
[[reStructuredText]] (reST, the markup used for writing the official Python documentation) or
[[http://daringfireball.net/projects/markdown/|Markdown]].


== Python docstrings ==

Python modules are usually documented using docstrings. You can read a module's docstrings from the Python interactive prompt with the `help()` function. For example:
{{{
import distutils
help(distutils)
}}}
The `help()` function uses Python's standard pydoc module, as does the `pydoc` command that comes with Python.


== Automatic Python API documentation generation tools ==

 * [[http://sphinx.pocoo.org/ext/autosummary.html|autosummary]], an extension for the Sphinx documentation tool.
 * [[http://sphinx.pocoo.org/ext/autodoc.html|autodoc]], a Sphinx-based processor that processes/allows reST doc strings.
 * [[https://github.com/BurntSushi/pdoc|pdoc]], a simple command line tool and library to auto generate API documentation for Python modules. Designed to replace epydoc and works on both Python 2 and 3. Includes support for cross-linking across modules, documentation for variables and namedtuples, and a built-in HTTP server to view documentation of local packages.
 * [[https://pdoc3.github.io/pdoc/|pdoc3]], an updated fork of pdoc for Python 3 which includes support for Numpydoc / Google-style docstrings, reST directives, PEP 484 type annotations, custom templates ...
 * [[https://www.pydoc.io|PyDoc]] a 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]].
 * [[https://launchpad.net/pydoctor|pydoctor]], a replacement for now inactive Epydoc, born for the needs of Twisted project.
 * [[http://www.doxygen.org|Doxygen]] can create documentation in various formats (HTML, LaTeX, PDF, ...) and you can include formulas in your documentation (great for technical/mathematical software). Together with [[http://graphviz.org/|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.

= No longer under development =

 * 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
Line 5: Line 42:
 * HappyDoc, http://happydoc.sourceforge.net/
 * 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/
 * ["Crystal"] - produces output that is similar to Wiki:JavaDoc.
 * [[https://svn.enthought.com/enthought/wiki/EndoHowTo|Endo]] from Enthought Tool Suite - generates HTML API documentation from docstrings and from plain comments that immediately precede variable assignments.
 * [[http://pudge.lesscode.org/|Pudge]] (defunct)
 * [[http://happydoc.sourceforge.net/|HappyDoc]] ([[http://sourceforge.net/projects/happydoc/forums/forum/30132/topic/3563472?message=8100340|not supported]]) - documentation extraction tool that uses the parse tree for a module to derive the information used in its output, rather that importing the module directly.
Line 9: Line 46:
 * ["Teud"], http://twistedmatrix.com/users/jh.twistd/python/moin.cgi/TeudProject  * 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/
 * Apydia, http://apydia.ematia.de/
Line 11: Line 49:
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.
== Documentation processing tools ==

 * DocUtils, http://docutils.sourceforge.net/ [[reStructuredText]] processing engine
 * [[Sphinx]], http://sphinx.pocoo.org/ - converts reStructuredText documentation into various formats

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

== Other documentation processing tools ==

 * [[http://johnmacfarlane.net/pandoc/|Pandoc]] -- written in Haskell, this tool can read and write a number of formats (including reST).
 * [[http://www.unexpected-vortices.com/sw/rippledoc/|Rippledoc]] (formerly known as Gouda) -- a command-line tool written in Clojure (using Pandoc under the hood) to generate multi-chapter html documents from Markdown text files.

----
CategoryDocumentation

This page is primarily about tools that help, specifically, in generating documentation for software written in Python, i.e., tools that can use language-specific features to automate at least a part of the code documentation work for you. The last section also lists general documentation tools with no specific support for Python (though some of them are themselves written in Python).

Tools that support auto-documentation of code can be broadly classified into tools that:

  • import the code to generate documentation based on runtime introspection
  • parse and analyze the code statically (without running it)

See here for a longer explanation of the two concepts.

Tools that generate documentation from user-provided input typically use plain text markup formats such as reStructuredText (reST, the markup used for writing the official Python documentation) or Markdown.

Python docstrings

Python modules are usually documented using docstrings. You can read a module's docstrings from the Python interactive prompt with the help() function. For example:

import distutils
help(distutils)

The help() function uses Python's standard pydoc module, as does the pydoc command that comes with Python.

Automatic Python API documentation generation tools

  • autosummary, an extension for the Sphinx documentation tool.

  • autodoc, a Sphinx-based processor that processes/allows reST doc strings.

  • pdoc, a simple command line tool and library to auto generate API documentation for Python modules. Designed to replace epydoc and works on both Python 2 and 3. Includes support for cross-linking across modules, documentation for variables and namedtuples, and a built-in HTTP server to view documentation of local packages.

  • pdoc3, an updated fork of pdoc for Python 3 which includes support for Numpydoc / Google-style docstrings, reST directives, PEP 484 type annotations, custom templates ...

  • PyDoc a documentation browser (in HTML) and/or an off-line reference manual. Also in the standard library as pydoc.

  • pydoctor, a replacement for now inactive Epydoc, born for the needs of Twisted project.

  • Doxygen 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, 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.

No longer under development

Documentation processing tools

Other projects that can be used to produce API documentation

  • XIST - an XML based extensible HTML generator written in Python.

  • HtmlGen - a Python library for generating HTML documents.

Other documentation processing tools

  • Pandoc -- written in Haskell, this tool can read and write a number of formats (including reST).

  • Rippledoc (formerly known as Gouda) -- a command-line tool written in Clojure (using Pandoc under the hood) to generate multi-chapter html documents from Markdown text files.


CategoryDocumentation

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

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