ANN: HappyDoc 2.0
Doug Hellmann
doug@hellfly.net
Sun, 30 Dec 2001 08:26:48 -0500
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 --
- **New Features**
- Rearranged much of the code base to create 'happydoclib'
package. This package protects the namespace for HappyDoc
related code, and makes it easier to reuse HappyDoc components
in other projects.
- Package descriptions can now come from the docstring of the
'__init__.py' module, instead of always having to be in a README
file.
- **Bug Fixes**
- Fixed a problem with the HTMLTable formatter that caused pages
to look odd in browsers which don't handle width attributes the
same way as Netscape.
- Upgraded to newer version of StructuredText package from Zope
CVS, resolving several rendering issues for the HTML formatter.
- **Other Changes**
- Changed command line argument handling to use '-' character in
names in addtition to underscore. That is, defining an
optionHandler_long_opt will allow the app to accept '--long-opt'
or '--long_opt'. The help text uses the '-' form, but both
are allowed on the command line for backwards compatability.
- Updated test cases to streamline regression testing.
- Rearranged some of the documentation from the root
'README.txt' into sub-packages.
Download
Download the latest version of HappyDoc from the home page on
SourceForge:
http://sourceforge.net/projects/happydoc