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

{{Module}}

{{ModuleDescription}}

Global Attributes

{{GlobalsList}}

Classes

{{ClassList}}

Functions

{{FunctionList}}
''' rbFileTemplate = '''

{{Module}}

{{ModuleDescription}}

Global Attributes

{{GlobalsList}}

Classes

{{ClassList}}

Modules

{{RbModulesList}}

Functions

{{FunctionList}}
''' classTemplate = '''

{{Class}}

{{ClassDescription}}

Derived from

{{ClassSuper}}

Class Attributes

{{GlobalsList}}

Class Methods

{{ClassMethodList}}

Methods

{{MethodList}}

Static Methods

{{StaticMethodList}} {{MethodDetails}}
Up

''' methodTemplate = '''

{{Class}}.{{Method}}{{MethodClassifier}}

{{Method}}({{Params}}) {{MethodDescription}}''' constructorTemplate = '''

{{Class}} (Constructor)

{{Class}}({{Params}}) {{MethodDescription}}''' rbModuleTemplate = '''

{{Module}}

{{ModuleDescription}}

Module Attributes

{{GlobalsList}}

Classes

{{ClassesList}}

Functions

{{FunctionsList}}
{{ClassesDetails}} {{FunctionsDetails}}
Up

''' rbModulesClassTemplate = '''

{{Class}}

{{ClassDescription}}

Derived from

{{ClassSuper}}

Methods

{{MethodList}} {{MethodDetails}}
Up

''' functionTemplate = '''

{{Function}}

{{Function}}({{Params}}) {{FunctionDescription}}
Up

''' listTemplate = ''' {{Entries}}
''' listEntryTemplate = ''' {{Name}} {{Deprecated}}{{Description}} ''' listEntryNoneTemplate = '''None''' listEntryDeprecatedTemplate = '''Deprecated.''' listEntrySimpleTemplate = '''{{Name}}''' paragraphTemplate = '''

{{Lines}}

''' parametersListTemplate = '''
{{Parameters}}
''' parametersListEntryTemplate = '''
{{Name}}
{{Description}}
''' parameterTypesListEntryTemplate = '''
{{Name}} ({{Type}})
{{Description}}
''' returnsTemplate = '''
Returns:
{{0}}
''' returnTypesTemplate = '''
Return Type:
{{0}}
''' exceptionsListTemplate = '''
{{Exceptions}}
''' exceptionsListEntryTemplate = '''
Raises {{Name}}:
{{Description}}
''' signalsListTemplate = '''

Signals

{{Signals}}
''' signalsListEntryTemplate = '''
{{Name}}
{{Description}}
''' eventsListTemplate = '''

Events

{{Events}}
''' eventsListEntryTemplate = '''
{{Name}}
{{Description}}
''' deprecatedTemplate = '''

Deprecated. {{Lines}}

''' authorInfoTemplate = '''

Author(s): {{Authors}}

''' seeListTemplate = '''
See Also:
{{Links}}
''' seeListEntryTemplate = '''
{{Link}}
''' seeLinkTemplate = ''' since {{Info}}

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

{{Title}}

{{Description}} {{Subpackages}} {{Modules}}''' indexListPackagesTemplate = '''

Packages

{{Entries}}
''' indexListModulesTemplate = '''

Modules

{{Entries}}
''' indexListEntryTemplate = '''
{{Name}} {{Description}} ''' # # eflag: noqa = E122