Revision 26 as of 2010-10-08 11:05:41

Clear message

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.

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

Currently, the Python docs consist of 2 parts:

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

No longer under development

Documentation processing tools

Other projects that can be used to produce API documentation

Other documentation processing tools


CategoryDocumentation

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