Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

Module epydoc.gui

Graphical interface to epydoc. This interface might be useful for systems where it's inconvenient to use the command-line interface (such as Windows). It supports all of the features that are supported by the command-line interface. It also supports loading and saving of project files, which store a set of related modules, and the options that should be used to generate the documentation for those modules.

Note: I put this together in an afternoon, so it might not be as clean and reliable as the other epydoc modules.

Any command line arguments ending in .prj will be loaded as project files; any other command line arguments will be added as modules (if possible).
Classes
EpydocGUI A graphical user interace to epydoc.

Function Summary
  document(modules, options, progress, cancel)
Create the documentation for modules, using the options specified by options.
  gui()

Function Details

document

document(modules, options, progress, cancel)

Create the documentation for modules, using the options specified by options. document is designed to be started in its own thread by EpydocGUI._go.
Parameters:
options - The options to use for generating documentation. This includes keyword options that can be given to html.HTML_Doc, as well as the option outdir, which controls where the output is written to.
           (type=dictionary)
progress - This first element of this list will be modified by document to reflect its progress. This first element will be a number between 0 and 1 while document is creating the documentation; and the string "done" once it finishes creating the documentation.
           (type=list)

gui

gui()


   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:12 2002 http://epydoc.sf.net