Home       Trees       Index       Help   

epydoc 3.0alpha2

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

Module gui
source code

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 many (but not 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


To Do: Use ini-style project files, rather than pickles (using the same format as the CLI).

Classes [hide private]
GUILogger  
EpydocGUI A graphical user interace to epydoc.

Functions [hide private]
  document(options, cancel, done)
Create the documentation for modules, using the options specified by options.
None _version()
Display the version information, and exit.
  _usage()
  _error(s)
  gui()

Variables [hide private]
DEBUG  
BG_COLOR  
ACTIVEBG_COLOR  
TEXT_COLOR  
ENTRYSELECT_COLOR  
SELECT_COLOR  
MESSAGE_COLOR  
ERROR_COLOR  
GUIERROR_COLOR  
WARNING_COLOR  
HEADER_COLOR  
COLOR_CONFIG  
ENTRY_CONFIG  
SB_CONFIG  
LISTBOX_CONFIG  
BUTTON_CONFIG  
CBUTTON_CONFIG  
SHOWMSG_CONFIG  
SHOWWRN_CONFIG  
SHOWERR_CONFIG  
PROGRESS_HEIGHT  
PROGRESS_WIDTH  
PROGRESS_BG  
PROGRESS_COLOR1  
PROGRESS_COLOR2  
PROGRESS_COLOR3  
DX  
DY  
DH  
DW  
IMPORT_PROGRESS  
BUILD_PROGRESS  
WRITE_PROGRESS  
UP_GIF  
DOWN_GIF  
LEFT_GIF  
RIGHT_GIF  

Function Details [hide private]

document(options, cancel, done)

source code 
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 (dictionary) - 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.

_version()

source code 
Display the version information, and exit.
Returns: None

_usage()

source code 

_error(s)

source code 

gui()

source code 

Variables Details [hide private]

DEBUG

Value:
0                                                                     

BG_COLOR

Value:
'#e0e0e0'

ACTIVEBG_COLOR

Value:
'#e0e0e0'

TEXT_COLOR

Value:
'black'

ENTRYSELECT_COLOR

Value:
'#e0e0e0'

SELECT_COLOR

Value:
'#208070'

MESSAGE_COLOR

Value:
'#000060'

ERROR_COLOR

Value:
'#600000'

GUIERROR_COLOR

Value:
'#600000'

WARNING_COLOR

Value:
'#604000'

HEADER_COLOR

Value:
'#000000'

COLOR_CONFIG

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

ENTRY_CONFIG

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

SB_CONFIG

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

LISTBOX_CONFIG

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

BUTTON_CONFIG

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

CBUTTON_CONFIG

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

SHOWMSG_CONFIG

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

SHOWWRN_CONFIG

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

SHOWERR_CONFIG

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

PROGRESS_HEIGHT

Value:
16                                                                    

PROGRESS_WIDTH

Value:
200                                                                   

PROGRESS_BG

Value:
'#305060'

PROGRESS_COLOR1

Value:
'#30c070'

PROGRESS_COLOR2

Value:
'#60ffa0'

PROGRESS_COLOR3

Value:
'#106030'

DX

Value:
1                                                                     

DY

Value:
1                                                                     

DH

Value:
1                                                                     

DW

Value:
3                                                                     

IMPORT_PROGRESS

Value:
0.10000000000000001                                                   

BUILD_PROGRESS

Value:
0.20000000000000001                                                   

WRITE_PROGRESS

Value:
0.70000000000000007                                                   

UP_GIF

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

DOWN_GIF

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

LEFT_GIF

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

RIGHT_GIF

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

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:31:23 2006 http://epydoc.sf.net