Table of Contents

HappyDoc Source Documentation  

Announcing the latest version of HappyDoc, a Python documentation extraction tool.

HappyDoc is a tool for extracting documentation from Python source code. It differs from other such applications by the fact that it uses the parse tree for a module to derive the information used in its output, rather that importing the module directly. This allows the user to generate documentation for modules which need special context to be imported.

More details are available on the HappyDoc home page at http://happydoc.sourceforge.net.

!!! NOTICE !!!

Before installing HappyDoc 2.0+, any version earlier than 2.0 must be removed. This includes the file happydoc.pth and directory happydoc in site-packages, as well as the executable happydoc in the bin directory.

Version 2.0.1
  • New Features

    • Added limited support for CGI programs by expanding the docset processing to look for files ending in .cgi as well as .py.

  • Bug Fixes

    • Resolved defect #505456 and 498204, a problem with happydocwin.py that prevented it from working properly on Win32 systems.

    • Resolved defect #501240 so that path handling under Win32 systems works properly and HappyDoc can generate output.

    • Resolved defect #505188 so that using the -o option will properly send output to stdout.

  • Other Changes

    • Added more unit tests for formatters, especially fileformatterbase.py and formatter_HTMLFile.py.

    • Updated the StructuredTextNG docstring converter so that if an exception is generated during parsing of the ST, we fall back to ClassicStructuredText. The two syntaxes appear to be incompatible, and this should protect backwards compatibility for most users.

Download

Download the latest version of HappyDoc from the home page on SourceForge:

http://sourceforge.net/projects/happydoc


Table of Contents

This document was automatically generated on Tue Feb 5 07:30:18 2002 by HappyDoc version 2.0.1