skip to navigation
skip to content

Python Documentation Special Interest Group

For discussion of both the form and content of Python documentation. The SIG should work towards setting up a Python Documentation Project effort like the Linux Documentation Project.

The Doc SIG members have produced some tools:

  • HTMLgen is now available from Robin Friedrich's starship website, as well as from the Python ftp site (that's a gzipped tar file; possibly an older version). There is a discussion group about HTMLgen on eGroups.
  • Doug Hellmann has created HappyDoc, a tool for extracting documentation from Python source code.
  • PythonDoc "generates API documentation in HTML and other formats, based on descriptions in Python source files. PythonDoc is a Python implementation of the JavaDoc (tm) tool."

Here is our current SIG status.