Inherits from
- OutputBase: enthought.endo.output.base.OutputBase
Attributes
- DATA_PATH
DATA_PATH = '/usr/share/enthought/endo'
- HAS_DOCUTILS
HAS_DOCUTILS = _HAS_DOCUTILS
Method summary
- __init__(self, options)
- copy_data_files(self)
- generate(self)
- get_extra_style(self)
- print_exception_list(self, header, exc_list)
- write(self, obj)
- write_class_hierarchy(self)
- write_class_index(self)
- write_index(self)
- write_namespace_index(self)
Methods
- __init__(self, options)
Constructor
- options is the parsed set of command-line options
- copy_data_files(self)
copy style, image, and script support files to output directory
- generate(self)
Generate HTML documentation in output directory
- get_extra_style(self)
returns the list of additional stylesheet files specified by user
- print_exception_list(self, header, exc_list)
Show the list of exceptions generated during documentation processing
- header : the text to display at the top of the list
- exc_list : list of tuples generated by sys.exc_info()
- write(self, obj)
Write HTML documentation
- obj is a docobjects.DocObject instance to be documented (must be either Module or Class)
This method produces a file PACKAGE.NAME.MODULE.NAME.html for modules, and PACKAGE.NAME.MODULE.NAME.CLASS.html for classes
- write_class_hierarchy(self)
Write class hierarchy index
Generates class_hierarchy.html in output directory
- write_class_index(self)
Generate alphabetical index of classes
Generates class_index.html in output directory
- write_index(self)
Write hierarchical module index
Generates index.html in output directory
- write_namespace_index(self)
Generate index of variables and functions
Creates namespace_index.html in output directory