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

Config for ScopePages module. ScopePages is the module that creates the bulk of the documentation - the pages for modules and classes, with summary and detail sections for each type of ast node. ScopePages is very modular, and all the modules it uses are in the ASTFormatter and FormatStrategy modules, which is where it looks if you use the 'simple' module spec. (FIXME)

Parameters:
parts - modules to use to generate parts of each page. The default package is Synopsis.Formatter.HTML.ASTFormatter and the default list is 'Heading','Summary', and 'Detail'
heading_formatters - list of modules for Heading page Part. The default is 'Heading', 'ClassHierarchyGraph', and 'DetailCommenter'.
summary_formatters - list of modules for SummaryFormatter to use. The default is ['SummaryAST', 'SummaryCommenter']
detail_formatters - list of modules for DetailFormatter to use. The default is ['DetailAST', 'ClassHierarchyGraph', 'DetailCommenter']. Note that it is these modules that are used to display the top of the class and module pages (hence the ClassHierarchyGraph module, which shows class hierarchies at the top of class pages).
See Also:
Synopsis.Formatter.HTML.ScopePages
Synopsis.Formatter.HTML.ASTFormatter