Home       Trees       Index       Help   

epydoc 2.0

Package epydoc :: Module gui
[show private | hide private]
[frames | no frames]

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.

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
  document(options, progress, cancel)
Create the documentation for modules, using the options specified by options.
  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 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.HTMLFormatter, 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)

Variable Details

ACTIVEBG_COLOR

Type:
str
Value:
'#e0e0e0'

BG_COLOR

Type:
str
Value:
'#e0e0e0'

BUILD_PROGRESS

Type:
float
Value:
0.20000000000000001                                                   

BUTTON_CONFIG

Type:
dict
Value:
{'activebackground': '#e0e0e0',
 'activeforeground': 'black',
 'background': '#e0e0e0',
 'foreground': 'black',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'highlightthickness': 0,
 'padx': 4,
...

CBUTTON_CONFIG

Type:
dict
Value:
{'activebackground': '#e0e0e0',
 'activeforeground': 'black',
 'background': '#e0e0e0',
 'foreground': 'black',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'highlightthickness': 0,
 'padx': 4,
...

COLOR_CONFIG

Type:
dict
Value:
{'background': '#e0e0e0',
 'foreground': 'black',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0'}

DEBUG

Type:
int
Value:
0                                                                     

DOWN_GIF

Type:
str
Value:
'''R0lGODlhCwAMALMAANnZ2QDMmQCZZgBmZgAAAAAzM////////wAAAAAAAAAAAAAAAAA\
AAAAAAAAA
AAAAACH5BAEAAAAALAAAAAALAAwAAAQmEIQxgLVUCsppsVPngVtXEFfIfWk5nBe4xuSL0t\
KLy/cu
7JffJQIAOw==
'''

ENTRY_CONFIG

Type:
dict
Value:
{'background': '#e0e0e0',
 'foreground': 'black',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'selectbackground': '#e0e0e0',
 'selectforeground': 'black'}

ENTRYSELECT_COLOR

Type:
str
Value:
'#e0e0e0'

ERROR_COLOR

Type:
str
Value:
'#600000'

GUIERROR_COLOR

Type:
str
Value:
'#600000'

HEADER_COLOR

Type:
str
Value:
'#000000'

IMPORT_PROGRESS

Type:
float
Value:
0.10000000000000001                                                   

LEFT_GIF

Type:
str
Value:
'''R0lGODlhDAALAKIAANnZ2QDMmQCZZgBmZgAAAAAzM////////yH5BAEAAAAALAAAAAA\
MAAsAAAM4
CLocgaCrESiDoBshOAoAgBEyMzgAEIGCowsiOLoLgEBVOLoIqlSFo4OgC1RYM4Ogq1RYg6\
DLVJgA
Ow==
'''

LISTBOX_CONFIG

Type:
dict
Value:
{'background': '#e0e0e0',
 'foreground': 'black',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'selectbackground': '#e0e0e0',
 'selectforeground': 'black'}

MESSAGE_COLOR

Type:
str
Value:
'#000060'

PROGRESS_BG

Type:
str
Value:
'#305060'

PROGRESS_COLOR1

Type:
str
Value:
'#30c070'

PROGRESS_COLOR2

Type:
str
Value:
'#60ffa0'

PROGRESS_COLOR3

Type:
str
Value:
'#106030'

PROGRESS_HEIGHT

Type:
int
Value:
16                                                                    

PROGRESS_WIDTH

Type:
int
Value:
200                                                                   

RIGHT_GIF

Type:
str
Value:
'''R0lGODlhDAALAKIAANnZ2QDMmQBmZgCZZgAzMwAAAP///////yH5BAEAAAAALAAAAAA\
MAAsAAAM5
GIGgyzIYgaCrIigTgaALIigyEQiqKLoTgaAoujuDgKJLVAgqIoJEBQAIIkKEhaArRFgIuk\
qFoMsJ
ADs=
'''

SB_CONFIG

Type:
dict
Value:
{'activebackground': '#e0e0e0',
 'background': '#e0e0e0',
 'highlightbackground': '#e0e0e0',
 'troughcolor': '#e0e0e0'}

SELECT_COLOR

Type:
str
Value:
'#208070'

SHOWERR_CONFIG

Type:
dict
Value:
{'activebackground': '#e0e0e0',
 'activeforeground': 'black',
 'background': '#e0e0e0',
 'foreground': '#600000',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'highlightthickness': 0,
 'padx': 4,
...

SHOWMSG_CONFIG

Type:
dict
Value:
{'activebackground': '#e0e0e0',
 'activeforeground': 'black',
 'background': '#e0e0e0',
 'foreground': '#000060',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'highlightthickness': 0,
 'padx': 4,
...

SHOWWRN_CONFIG

Type:
dict
Value:
{'activebackground': '#e0e0e0',
 'activeforeground': 'black',
 'background': '#e0e0e0',
 'foreground': '#604000',
 'highlightbackground': '#e0e0e0',
 'highlightcolor': '#e0e0e0',
 'highlightthickness': 0,
 'padx': 4,
...

TEXT_COLOR

Type:
str
Value:
'black'

UP_GIF

Type:
str
Value:
'''R0lGODlhCwAMALMAANnZ2QDMmQCZZgBmZgAAAAAzM////////wAAAAAAAAAAAAAAAAA\
AAAAAAAAA
AAAAACH5BAEAAAAALAAAAAALAAwAAAQjEMhJKxCW4gzCIJxXZIEwFGDlDadqsii1sq1U0n\
A64+ON
5xEAOw==
'''

WARNING_COLOR

Type:
str
Value:
'#604000'

WRITE_PROGRESS

Type:
float
Value:
0.70000000000000007                                                   

   Home       Trees       Index       Help   

epydoc 2.0

Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004 http://epydoc.sf.net