# -*- coding: utf-8 -*- # Copyright (c) 2004 - 2009 Detlev Offenbach # """ Module implementing templates for the documentation generator (lists style). """ ################################################# ## Common templates for index and docu files ## ################################################# headerTemplate = \ ''' %%(Title)s ''' footerTemplate = ''' ''' ######################################### ## Templates for documentation files ## ######################################### moduleTemplate = \ '''

%%(Module)s

%%(ModuleDescription)s

Global Attributes

%%(GlobalsList)s

Classes

%%(ClassList)s

Functions

%%(FunctionList)s
''' rbFileTemplate = \ '''

%%(Module)s

%%(ModuleDescription)s

Global Attributes

%%(GlobalsList)s

Classes

%%(ClassList)s

Modules

%%(RbModulesList)s

Functions

%%(FunctionList)s
''' classTemplate = \ '''

%%(Class)s

%%(ClassDescription)s

Derived from

%%(ClassSuper)s

Class Attributes

%%(GlobalsList)s

Methods

%%(MethodList)s %%(MethodDetails)s
Up

''' methodTemplate = \ '''

%%(Class)s.%%(Method)s

%%(Method)s(%%(Params)s) %%(MethodDescription)s''' constructorTemplate = \ '''

%%(Class)s (Constructor)

%%(Class)s(%%(Params)s) %%(MethodDescription)s''' rbModuleTemplate = \ '''

%%(Module)s

%%(ModuleDescription)s

Module Attributes

%%(GlobalsList)s

Classes

%%(ClassesList)s

Functions

%%(FunctionsList)s
%%(ClassesDetails)s %%(FunctionsDetails)s
Up

''' rbModulesClassTemplate = \ '''

%%(Class)s

%%(ClassDescription)s

Derived from

%%(ClassSuper)s

Methods

%%(MethodList)s %%(MethodDetails)s
Up

''' functionTemplate = \ '''

%%(Function)s

%%(Function)s(%%(Params)s) %%(FunctionDescription)s
Up

''' listTemplate = \ ''' %%(Entries)s
''' listEntryTemplate = \ ''' %%(Name)s %%(Deprecated)s%%(Description)s ''' listEntryNoneTemplate = \ '''None''' listEntryDeprecatedTemplate = \ '''Deprecated.''' listEntrySimpleTemplate = \ '''%%(Name)s''' paragraphTemplate = \ '''

%%(Lines)s

''' parametersListTemplate = \ '''
%%(Parameters)s
''' parametersListEntryTemplate = \ '''
%%(Name)s
%%(Description)s
''' returnsTemplate = \ '''
Returns:
%%s
''' exceptionsListTemplate = \ '''
%%(Exceptions)s
''' exceptionsListEntryTemplate = \ '''
Raises %%(Name)s:
%%(Description)s
''' signalsListTemplate = \ '''

Signals

%%(Signals)s
''' signalsListEntryTemplate = \ '''
%%(Name)s
%%(Description)s
''' eventsListTemplate = \ '''

Events

%%(Events)s
''' eventsListEntryTemplate = \ '''
%%(Name)s
%%(Description)s
''' deprecatedTemplate = \ '''

Deprecated. %%(Lines)s

''' authorInfoTemplate = \ '''

Author(s): %%(Authors)s

''' seeListTemplate = \ '''
See Also:
%%(Links)s
''' seeListEntryTemplate = \ '''
%%(Link)s
''' seeLinkTemplate = \ ''' since %%(Info)s

''' ################################# ## Templates for index files ## ################################# indexBodyTemplate = '''

%%(Title)s

%%(Description)s %%(Subpackages)s %%(Modules)s''' indexListPackagesTemplate = '''

Packages

%%(Entries)s
''' indexListModulesTemplate = '''

Modules

%%(Entries)s
''' indexListEntryTemplate = \ '''
%%(Name)s %%(Description)s '''