Projects / HappyDoc

HappyDoc

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 instead of importing the module directly. This allows the user to generate documentation for modules which need special context to be imported.

Tags
Licenses
Operating Systems
Implementation

Recent releases

  •  25 Aug 2002 01:43

    Release Notes: A bug was fixed where output was written to the wrong place when the -d option was used. The PluginLoader no longer requires a '.py' extension on plugins, allowing plugins not written in Python.

    •  30 Dec 2001 16:15

      Release Notes: Much of the code base has been rearranged to protect the namespace for HappyDoc code (as well as other Python libraries). Package descriptions can now be extracted from the __init__.py module docstring instead of always having to be in a README file. A problem with the HTMLTable formatter that caused pages to look odd in many browsers was fixed.

      •  21 Nov 2001 17:54

        Release Notes: A variety of modifications were implemented to support Python 2.0 syntax updates. A plugin system was added for docstring converters to allow module authors to write docs using different markup styles. External files are now recognized by their extension. The global default setting for docstrings can be passed on the command line or a file-specific setting can be embedded in the input file. The default markup syntax was updated to StructuredTextNG, replacing the original StructuredText. A system to allow file-specific parser control variables to be embedded in the input source files was implemented.

        •  13 Sep 2000 16:52

          Release Notes: This is the initial release announcement on freshmeat. Version 0.7.1 is still in development, but should be usable. It has not been assigned a 1.x version number because there are core features left to be implemented.

          Recent comments

          25 Aug 2002 12:08 berhoel

          Re: HappyDoc_r2_1.tar.gz on sourceforge seems to be broken
          Great, Thank You

          Berthold

          25 Aug 2002 09:48 doughellmann

          Re: HappyDoc_r2_1.tar.gz on sourceforge seems to be broken
          Thanks for the note, Berthold. I have uploaded a corrected file, and tested it myself this time. Everything should be ready to go now.

          25 Aug 2002 08:37 berhoel

          HappyDoc_r2_1.tar.gz on sourceforge seems to be broken
          Hello,

          I downloaded HappyDoc_r2_1.tar.gz from the belnet sourceforge mirror.
          Trying to unpack the archive I get:

          > tar tzf HappyDoc_r2_1.tar.gz
          ...
          HappyDoc-r2_1/srcdocs/HappyDoc-r2_1/happydoclib/parseinfo/classinfo/
          HappyDoc-r2_1/srcdocs/HappyDoc-r2_1/happydoclib/parseinfo/classinfo/ClassInfo.html

          gzip: stdin: unexpected end of file
          HappyDoc-r2_1/srcdocs/HappyDoc-r2_1/happydoclib/parseinfo/functioninfo.html
          HappyDoc-r2_1/srcdocs/HappyDoc-r2_1/happydoclib/parseinfo/functioninfo/
          HappyDoc-r2_1/srcdocs/HappyDoc-r2_1/happydoclib/parseinfo/functioninfo/FunctionInfo.html
          tar: Unexpected EOF in archive
          tar: Error is not recoverable: exiting now

          > md5sum HappyDoc_r2_1.tar.gz
          3ec85475ec64cece4b2ea5e7c1737bdf HappyDoc_r2_1.tar.gz
          > ll HappyDoc_r2_1.tar.gz
          -rw-r--r-- 1 downl downl 476392 Aug 24 22:59 HappyDoc_r2_1.tar.gz

          Greetings

          Berthold

          Screenshot

          Project Spotlight

          OpenStack4j

          A Fluent OpenStack client API for Java.

          Screenshot

          Project Spotlight

          TurnKey TWiki Appliance

          A TWiki appliance that is easy to use and lightweight.