Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
module Synopsis::Formatter::HTML::core
class Config
Files: Synopsis/Formatter/HTML/core.py

Central configuration repository for HTML formatter. This class holds references to the current formatters, tocs, etc.

Operations Summary:
 __init__(self)
Constructor - initialise objects to None. [Source]
 fillDefaults(self)
Fill in empty options with defaults [Source]
 use_config(self, obj)
Extracts useful attributes from 'obj' and stores them. [Source]
 _config_pages(self, pages)
Configures from the given list of pages [Source]
 _config_sorter(self, sorter) [Source]
 _config_datadir(self, datadir) [Source]
 _config_output_dir(self, output_dir) [Source]
 _config_stylesheet(self, stylesheet) [Source]
 _config_stylesheet_file(self, stylesheet_file) [Source]
 _config_comment_formatters(self, comment_formatters) [Source]
 _config_toc_in(self, toc_in) [Source]
 _config_default_toc(self, page) [Source]
 _config_toc_out(self, toc_out) [Source]
 _config_tree_formatter(self, tree_class) [Source]
 _config_file_layout(self, layout) [Source]
 _config_base_dir(self, dir) [Source]
 _config_start_dir(self, dir) [Source]
 _config_structs_as_classes(self, yesno) [Source]
 _config_exclude_globs(self, globs) [Source]
 _config_page_format(self, page_format) [Source]
 set_contents_page(self, page)
Call this method to set the contents page. [Source]
 set_index_page(self, page)
Call this method to set the index page. [Source]
 set_main_page(self, page)
Call this method to set the main index.html page. [Source]
 set_using_module_index(self)
Sets the using_module_index flag. [Source]

Operation Details:
  use_config(self, obj)

Extracts useful attributes from 'obj' and stores them. The object itself is also stored as config.obj

  set_contents_page(self, page)

Call this method to set the contents page. First come first served -- whatever module the user puts first in the list that sets this is it. This is the frame in the top-left if you use the default frameset.

  set_index_page(self, page)

Call this method to set the index page. First come first served -- whatever module the user puts first in the list that sets this is it. This is the frame on the left if you use the default frameset.

  set_main_page(self, page)

Call this method to set the main index.html page. First come first served -- whatever module the user puts first in the list that sets this is it.

  set_using_module_index(self)

Sets the using_module_index flag. This will cause the an intermediate level of links intended to go in the left frame.