faqts : Computers : Programming : Languages : Python : Common Problems

+ Search
Add Entry AlertManage Folder Edit Entry Add page to http://del.icio.us/
Did You Find This Entry Useful?

3 of 7 people (43%) answered Yes
Recently 2 of 6 people (33%) answered Yes

Entry

Is there a utility to convert module docstrings to HTML for nice documentation?

Jul 11th, 2000 04:27
unknown unknown, Stu D, David Goodger


From http://starship.python.net/crew/danilo/download.html:
Gendoc generates documentation from Python source code in different 
formats. Currently it can generate HTML, MIF, MML and plain old ascii 
(MIF and MML are FrameMaker formats). If you want to generate HTML 
files, I strongly suggest you grab a copy of Robin Friedrich's HTMLgen 
package, with which gendoc generates quite nice pages, optionally with 
frames.
In addition to gendoc/HTMLgen, there are several others I know of:
pythondoc (the successor to gendoc):
    http://starship.python.net/crew/danilo/pythondoc/
manpy:
    http://www.lfw.org/python/
crystal:
    http://www.btinternet.com/~tratt/comp/python/crystal/index.html
structured text (part of Zope; used by several of these projects):
    http://www.zope.org/Members/millejoh/structuredText