[Tutor] Documenting a Module

ralf at schoenian-online.de ralf at schoenian-online.de
Mon Sep 13 12:03:27 CEST 2010


Hi Michael,
 
I can recommend epydoc. You can find it here:
 http://epydoc.sourceforge.net/ It's a nice tool and you should have no problems
with the installation.
 
Ralf
 
 
 

Michael Powe <michael at trollope.org> hat am 13. September 2010 um 11:54
geschrieben:

> Hello,
>
> Are there any tools for documenting a module other than Sphinx?
>
> Apparently, I need a full-blown dev box with Visual Studio installed
> to get Sphinx up, due to the dependency on Jinja, which comes
> source-only and requires VC.
>
> I wrote a module, I'd like to produce a decent document of its
> functionality from the comments and doc strings; and I already wasted
> a considerable part of my Sunday afternoon trying to get along with
> Sphinx. I'm not talking about a huge Python project, nor am I likely
> to need that type of documentation tool in the near future.
>
> Thanks.
>
> mp
>
> --
> Michael Powe                michael at trollope.org                Naugatuck CT
> USA
>
>
> Is it time for your medication or mine?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/tutor/attachments/20100913/afde478b/attachment.html>


More information about the Tutor mailing list