| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module 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.
Usage:epydocgui [OPTIONS] [FILE.prj | MODULES...] FILE.prj An epydoc GUI project file. MODULES... A list of Python modules to document. -V, --version Print the version of epydoc. -h, -?, --help, --usage Display this usage message --debug Do not suppress error messages
| Classes | |
|---|---|
| EpydocGUI | A graphical user interace to epydoc. | 
| Function Summary | |
|---|---|
| Create the documentation for modules, using the options 
specified byoptions. | |
| gui() | |
| Variable Summary | |
|---|---|
| str | ACTIVEBG_COLOR='#e0e0e0'                                | 
| str | BG_COLOR='#e0e0e0'                                      | 
| float | BUILD_PROGRESS= 0.20000000000000001 | 
| dict | BUTTON_CONFIG={'foreground': 'black', 'highlightcolor'... | 
| dict | CBUTTON_CONFIG={'foreground': 'black', 'highlightcolor... | 
| dict | COLOR_CONFIG={'foreground': 'black', 'highlightcolor':... | 
| int | DEBUG= 0 | 
| str | DOWN_GIF='R0lGODlhCwAMALMAANnZ2QDMmQCZZgBmZgAAAAAzM///... | 
| dict | ENTRY_CONFIG={'foreground': 'black', 'selectforeground... | 
| str | ENTRYSELECT_COLOR='#e0e0e0'                             | 
| str | ERROR_COLOR='#600000'                                   | 
| str | GUIERROR_COLOR='#600000'                                | 
| str | HEADER_COLOR='#000000'                                  | 
| float | IMPORT_PROGRESS= 0.10000000000000001 | 
| str | LEFT_GIF='R0lGODlhDAALAKIAANnZ2QDMmQCZZgBmZgAAAAAzM///... | 
| dict | LISTBOX_CONFIG={'foreground': 'black', 'selectforegrou... | 
| str | MESSAGE_COLOR='#000060'                                 | 
| str | PROGRESS_BG='#305060'                                   | 
| str | PROGRESS_COLOR1='#30c070'                               | 
| str | PROGRESS_COLOR2='#60ffa0'                               | 
| str | PROGRESS_COLOR3='#106030'                               | 
| int | PROGRESS_HEIGHT= 16 | 
| int | PROGRESS_WIDTH= 200 | 
| str | RIGHT_GIF='R0lGODlhDAALAKIAANnZ2QDMmQBmZgCZZgAzMwAAAP/... | 
| dict | SB_CONFIG={'highlightbackground': '#e0e0e0', 'backgrou... | 
| str | SELECT_COLOR='#208070'                                  | 
| dict | SHOWERR_CONFIG={'foreground': '#600000', 'highlightcol... | 
| dict | SHOWMSG_CONFIG={'foreground': '#000060', 'highlightcol... | 
| dict | SHOWWRN_CONFIG={'foreground': '#604000', 'highlightcol... | 
| str | TEXT_COLOR='black'                                      | 
| str | UP_GIF='R0lGODlhCwAMALMAANnZ2QDMmQCZZgBmZgAAAAAzM/////... | 
| str | WARNING_COLOR='#604000'                                 | 
| float | WRITE_PROGRESS= 0.70000000000000007 | 
| Function Details | 
|---|
| document(options, progress, cancel)Create the documentation formodules, using the options 
  specified byoptions.documentis designed to 
  be started in its own thread byEpydocGUI._go.
 | 
| Variable Details | 
|---|
| ACTIVEBG_COLOR
 | 
| BG_COLOR
 | 
| BUILD_PROGRESS
 | 
| CBUTTON_CONFIG
 | 
| COLOR_CONFIG
 | 
| DEBUG
 | 
| DOWN_GIF
 | 
| ENTRY_CONFIG
 | 
| ENTRYSELECT_COLOR
 | 
| ERROR_COLOR
 | 
| GUIERROR_COLOR
 | 
| HEADER_COLOR
 | 
| IMPORT_PROGRESS
 | 
| LEFT_GIF
 | 
| LISTBOX_CONFIG
 | 
| MESSAGE_COLOR
 | 
| PROGRESS_BG
 | 
| PROGRESS_COLOR1
 | 
| PROGRESS_COLOR2
 | 
| PROGRESS_COLOR3
 | 
| PROGRESS_HEIGHT
 | 
| PROGRESS_WIDTH
 | 
| RIGHT_GIF
 | 
| SB_CONFIG
 | 
| SELECT_COLOR
 | 
| SHOWERR_CONFIG
 | 
| SHOWMSG_CONFIG
 | 
| SHOWWRN_CONFIG
 | 
| TEXT_COLOR
 | 
| UP_GIF
 | 
| WARNING_COLOR
 | 
| WRITE_PROGRESS
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004 | http://epydoc.sf.net |