--- a/eric7/DocumentationTools/ModuleDocumentor.py Sun Sep 12 17:30:38 2021 +0200
+++ b/eric7/DocumentationTools/ModuleDocumentor.py Sun Sep 12 20:22:27 2021 +0200
@@ -18,6 +18,8 @@
from Utilities import html_uencode
from Utilities.ModuleParser import RB_SOURCE, Function
+from . import TemplatesListsStyleCSS
+
_signal = re.compile(
r"""
^@signal [ \t]+
@@ -60,149 +62,68 @@
"""
Class implementing the builtin documentation generator.
"""
- def __init__(self, module, colors, stylesheet=None):
+ def __init__(self, module):
"""
Constructor
- @param module the information of the parsed Python file
- @param colors dictionary specifying the various colors for the output
- (dictionary of strings)
- @param stylesheet the style to be used for the generated pages (string)
+ @param outputDir The output directory for the files
+ @type str
"""
self.module = module
self.empty = True
- self.stylesheet = stylesheet
-
- if self.stylesheet:
- from . import TemplatesListsStyleCSS
- self.headerTemplate = TemplatesListsStyleCSS.headerTemplate
- self.footerTemplate = TemplatesListsStyleCSS.footerTemplate
- self.moduleTemplate = TemplatesListsStyleCSS.moduleTemplate
- self.rbFileTemplate = TemplatesListsStyleCSS.rbFileTemplate
- self.classTemplate = TemplatesListsStyleCSS.classTemplate
- self.methodTemplate = TemplatesListsStyleCSS.methodTemplate
- self.constructorTemplate = (
- TemplatesListsStyleCSS.constructorTemplate)
- self.rbModuleTemplate = TemplatesListsStyleCSS.rbModuleTemplate
- self.rbModulesClassTemplate = (
- TemplatesListsStyleCSS.rbModulesClassTemplate)
- self.functionTemplate = TemplatesListsStyleCSS.functionTemplate
- self.listTemplate = TemplatesListsStyleCSS.listTemplate
- self.listEntryTemplate = TemplatesListsStyleCSS.listEntryTemplate
- self.listEntryNoneTemplate = (
- TemplatesListsStyleCSS.listEntryNoneTemplate)
- self.listEntryDeprecatedTemplate = (
- TemplatesListsStyleCSS.listEntryDeprecatedTemplate)
- self.listEntrySimpleTemplate = (
- TemplatesListsStyleCSS.listEntrySimpleTemplate)
- self.paragraphTemplate = TemplatesListsStyleCSS.paragraphTemplate
- self.parametersListTemplate = (
- TemplatesListsStyleCSS.parametersListTemplate)
- self.parameterTypesListEntryTemplate = (
- TemplatesListsStyleCSS.parameterTypesListEntryTemplate)
- self.parametersListEntryTemplate = (
- TemplatesListsStyleCSS.parametersListEntryTemplate)
- self.returnsTemplate = TemplatesListsStyleCSS.returnsTemplate
- self.returnTypesTemplate = (
- TemplatesListsStyleCSS.returnTypesTemplate)
- self.yieldsTemplate = TemplatesListsStyleCSS.yieldsTemplate
- self.yieldTypesTemplate = (
- TemplatesListsStyleCSS.yieldTypesTemplate)
- self.exceptionsListTemplate = (
- TemplatesListsStyleCSS.exceptionsListTemplate)
- self.exceptionsListEntryTemplate = (
- TemplatesListsStyleCSS.exceptionsListEntryTemplate)
- self.signalsListTemplate = (
- TemplatesListsStyleCSS.signalsListTemplate)
- self.signalsListEntryTemplate = (
- TemplatesListsStyleCSS.signalsListEntryTemplate)
- self.eventsListTemplate = TemplatesListsStyleCSS.eventsListTemplate
- self.eventsListEntryTemplate = (
- TemplatesListsStyleCSS.eventsListEntryTemplate)
- self.deprecatedTemplate = TemplatesListsStyleCSS.deprecatedTemplate
- self.authorInfoTemplate = TemplatesListsStyleCSS.authorInfoTemplate
- self.seeListTemplate = TemplatesListsStyleCSS.seeListTemplate
- self.seeListEntryTemplate = (
- TemplatesListsStyleCSS.seeListEntryTemplate)
- self.seeLinkTemplate = TemplatesListsStyleCSS.seeLinkTemplate
- self.sinceInfoTemplate = TemplatesListsStyleCSS.sinceInfoTemplate
- else:
- from . import TemplatesListsStyle
- self.headerTemplate = (
- TemplatesListsStyle.headerTemplate.format(**colors))
- self.footerTemplate = (
- TemplatesListsStyle.footerTemplate.format(**colors))
- self.moduleTemplate = (
- TemplatesListsStyle.moduleTemplate.format(**colors))
- self.rbFileTemplate = (
- TemplatesListsStyle.rbFileTemplate.format(**colors))
- self.classTemplate = (
- TemplatesListsStyle.classTemplate.format(**colors))
- self.methodTemplate = (
- TemplatesListsStyle.methodTemplate.format(**colors))
- self.constructorTemplate = (
- TemplatesListsStyle.constructorTemplate.format(**colors))
- self.rbModuleTemplate = (
- TemplatesListsStyle.rbModuleTemplate.format(**colors))
- self.rbModulesClassTemplate = (
- TemplatesListsStyle.rbModulesClassTemplate.format(**colors))
- self.functionTemplate = (
- TemplatesListsStyle.functionTemplate.format(**colors))
- self.listTemplate = (
- TemplatesListsStyle.listTemplate.format(**colors))
- self.listEntryTemplate = (
- TemplatesListsStyle.listEntryTemplate.format(**colors))
- self.listEntryNoneTemplate = (
- TemplatesListsStyle.listEntryNoneTemplate.format(**colors))
- self.listEntryDeprecatedTemplate = (
- TemplatesListsStyle.listEntryDeprecatedTemplate.format(
- **colors))
- self.listEntrySimpleTemplate = (
- TemplatesListsStyle.listEntrySimpleTemplate.format(**colors))
- self.paragraphTemplate = (
- TemplatesListsStyle.paragraphTemplate.format(**colors))
- self.parametersListTemplate = (
- TemplatesListsStyle.parametersListTemplate.format(**colors))
- self.parametersListEntryTemplate = (
- TemplatesListsStyle.parametersListEntryTemplate.format(
- **colors))
- self.parameterTypesListEntryTemplate = (
- TemplatesListsStyle.parameterTypesListEntryTemplate.format(
- **colors))
- self.returnsTemplate = (
- TemplatesListsStyle.returnsTemplate.format(**colors))
- self.returnTypesTemplate = (
- TemplatesListsStyle.returnTypesTemplate.format(**colors))
- self.yieldsTemplate = (
- TemplatesListsStyle.yieldsTemplate.format(**colors))
- self.yieldTypesTemplate = (
- TemplatesListsStyle.yieldTypesTemplate.format(**colors))
- self.exceptionsListTemplate = (
- TemplatesListsStyle.exceptionsListTemplate.format(**colors))
- self.exceptionsListEntryTemplate = (
- TemplatesListsStyle.exceptionsListEntryTemplate.format(
- **colors))
- self.signalsListTemplate = (
- TemplatesListsStyle.signalsListTemplate.format(**colors))
- self.signalsListEntryTemplate = (
- TemplatesListsStyle.signalsListEntryTemplate.format(**colors))
- self.eventsListTemplate = (
- TemplatesListsStyle.eventsListTemplate.format(**colors))
- self.eventsListEntryTemplate = (
- TemplatesListsStyle.eventsListEntryTemplate.format(**colors))
- self.deprecatedTemplate = (
- TemplatesListsStyle.deprecatedTemplate.format(**colors))
- self.authorInfoTemplate = (
- TemplatesListsStyle.authorInfoTemplate.format(**colors))
- self.seeListTemplate = (
- TemplatesListsStyle.seeListTemplate.format(**colors))
- self.seeListEntryTemplate = (
- TemplatesListsStyle.seeListEntryTemplate.format(**colors))
- self.seeLinkTemplate = (
- TemplatesListsStyle.seeLinkTemplate.format(**colors))
- self.sinceInfoTemplate = (
- TemplatesListsStyle.sinceInfoTemplate.format(**colors))
+ # TODO: replace these assignments
+ self.headerTemplate = TemplatesListsStyleCSS.headerTemplate
+ self.footerTemplate = TemplatesListsStyleCSS.footerTemplate
+ self.moduleTemplate = TemplatesListsStyleCSS.moduleTemplate
+ self.rbFileTemplate = TemplatesListsStyleCSS.rbFileTemplate
+ self.classTemplate = TemplatesListsStyleCSS.classTemplate
+ self.methodTemplate = TemplatesListsStyleCSS.methodTemplate
+ self.constructorTemplate = (
+ TemplatesListsStyleCSS.constructorTemplate)
+ self.rbModuleTemplate = TemplatesListsStyleCSS.rbModuleTemplate
+ self.rbModulesClassTemplate = (
+ TemplatesListsStyleCSS.rbModulesClassTemplate)
+ self.functionTemplate = TemplatesListsStyleCSS.functionTemplate
+ self.listTemplate = TemplatesListsStyleCSS.listTemplate
+ self.listEntryTemplate = TemplatesListsStyleCSS.listEntryTemplate
+ self.listEntryNoneTemplate = (
+ TemplatesListsStyleCSS.listEntryNoneTemplate)
+ self.listEntryDeprecatedTemplate = (
+ TemplatesListsStyleCSS.listEntryDeprecatedTemplate)
+ self.listEntrySimpleTemplate = (
+ TemplatesListsStyleCSS.listEntrySimpleTemplate)
+ self.paragraphTemplate = TemplatesListsStyleCSS.paragraphTemplate
+ self.parametersListTemplate = (
+ TemplatesListsStyleCSS.parametersListTemplate)
+ self.parameterTypesListEntryTemplate = (
+ TemplatesListsStyleCSS.parameterTypesListEntryTemplate)
+ self.parametersListEntryTemplate = (
+ TemplatesListsStyleCSS.parametersListEntryTemplate)
+ self.returnsTemplate = TemplatesListsStyleCSS.returnsTemplate
+ self.returnTypesTemplate = (
+ TemplatesListsStyleCSS.returnTypesTemplate)
+ self.yieldsTemplate = TemplatesListsStyleCSS.yieldsTemplate
+ self.yieldTypesTemplate = (
+ TemplatesListsStyleCSS.yieldTypesTemplate)
+ self.exceptionsListTemplate = (
+ TemplatesListsStyleCSS.exceptionsListTemplate)
+ self.exceptionsListEntryTemplate = (
+ TemplatesListsStyleCSS.exceptionsListEntryTemplate)
+ self.signalsListTemplate = (
+ TemplatesListsStyleCSS.signalsListTemplate)
+ self.signalsListEntryTemplate = (
+ TemplatesListsStyleCSS.signalsListEntryTemplate)
+ self.eventsListTemplate = TemplatesListsStyleCSS.eventsListTemplate
+ self.eventsListEntryTemplate = (
+ TemplatesListsStyleCSS.eventsListEntryTemplate)
+ self.deprecatedTemplate = TemplatesListsStyleCSS.deprecatedTemplate
+ self.authorInfoTemplate = TemplatesListsStyleCSS.authorInfoTemplate
+ self.seeListTemplate = TemplatesListsStyleCSS.seeListTemplate
+ self.seeListEntryTemplate = (
+ TemplatesListsStyleCSS.seeListEntryTemplate)
+ self.seeLinkTemplate = TemplatesListsStyleCSS.seeLinkTemplate
+ self.sinceInfoTemplate = TemplatesListsStyleCSS.sinceInfoTemplate
self.keywords = []
# list of tuples containing the name (string) and
@@ -254,8 +175,7 @@
"""
doc = (
self.headerTemplate.format(
- **{'Title': self.module.name,
- 'Style': self.stylesheet}
+ **{'Title': self.module.name}
) +
self.__genModuleSection() +
self.footerTemplate
