Differences between revisions 22 and 25 (spanning 3 versions)
Revision 22 as of 2010-05-02 12:21:04
Size: 4093
Editor: techtonik
Comment: removing Teud and Crystal - no more available
Revision 25 as of 2010-10-08 11:01:46
Size: 4465
Editor: MichaelFoord
Deletions are marked like this. Additions are marked like this.
Line 22: Line 22:
 * autosummary, an extension for the Sphinx documentation tool: http://sphinx.pocoo.org/ext/autosummary.html
Line 24: Line 25:
 * pydoctor, http://codespeak.net/~mwh/pydoctor/ replacement for now inactive Epydoc, pydoctor was born far the needs of Twisted project
Line 29: Line 31:
 * [[http://sphinx.pocoo.org/ext/autodoc.html|autodoc]], a Sphinx-based processor that processes/allows reST doc strings,

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

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

The various documentation tools available generally do one of two things:

  • they either process docstrings in some way to make finding/reading documentation on a given module easier (so-called "API documentation tools"), or
  • they have nothing to do with docstrings and instead focus on processing documentation in some way (such as converting your plain text docs into html)

Currently, the Python docs consist of 2 parts:

  • the API docs that you can read using the help() command (pydoc can also provide these as html and even serve them from your local machine), and

  • the manuals/guides/howtos at http://python.org/doc/ which are written in reStructuredText (a plain text format) and processed into various output formats by the Sphinx tool.

When writing documentation for your own modules (either as manuals or docstrings (preferably both)), I suggest you use a plain text markup such as reST or Markdown.

Automatic Python API documentation generation tools

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


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

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