I am missing a code example

2001-02-05
2001-02-10
  • Thanks for posting a message on the announce list. I guess a good documentation tool can make programming much effectiver.
    Unfortunately visiting your page at SourceForge I wasn't able to figure out how your module helps documenting programs. Could you put a bit of python code using this kind of documentation on your page? So one could get an idea about it without downloading and installing the module.
    Thanks!
    Gabor BORGULYA

     
    • Doug Hellmann
      Doug Hellmann
      2001-02-05

      The readme information at <a href="http://happydoc.sourceforge.net">http://happydoc.sourceforge.net</a> should provide enough instructions to get you started.

      The idea is, you write the documentation in your code as __doc__ strings or comments, and then you run HappyDoc with your code as input.  The output is documentation in whatever format you've chosen (HTML by default).

       
      • Thank you! Gabor

         
    • Doug Hellmann
      Doug Hellmann
      2001-02-05

      Sorry, that URL should just read http://happydoc.sourceforge.net (I'm still getting used to the Sourceforge tools).