Revision 16 as of 2009-09-20 21:58:20

Clear message

Documentation of Python modules is most-often done by adding docstrings to your code. You can read a module's docstrings from the Python interactive prompt (the "REPL") by using 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

Other projects that can be used to produce API documentation

Other documentation processing tools

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