Mercurial Repositories > eric / file comparison
comparison: eric6/DocumentationTools/IndexGenerator.py
eric6/DocumentationTools/IndexGenerator.py
- changeset 7252
- c5e3705073eb
- parent 7229
- 53054eb5b15a
- child 7360
- 9190402e4505
equal
deleted
inserted
replaced
| 7251:bc5b1b00560a | 7252:c5e3705073eb |
|---|---|
| 44 if self.stylesheet: | 44 if self.stylesheet: |
| 45 from . import TemplatesListsStyleCSS | 45 from . import TemplatesListsStyleCSS |
| 46 self.headerTemplate = TemplatesListsStyleCSS.headerTemplate | 46 self.headerTemplate = TemplatesListsStyleCSS.headerTemplate |
| 47 self.footerTemplate = TemplatesListsStyleCSS.footerTemplate | 47 self.footerTemplate = TemplatesListsStyleCSS.footerTemplate |
| 48 self.indexBodyTemplate = TemplatesListsStyleCSS.indexBodyTemplate | 48 self.indexBodyTemplate = TemplatesListsStyleCSS.indexBodyTemplate |
| 49 self.indexListPackagesTemplate = \ | 49 self.indexListPackagesTemplate = ( |
| 50 TemplatesListsStyleCSS.indexListPackagesTemplate | 50 TemplatesListsStyleCSS.indexListPackagesTemplate) |
| 51 self.indexListModulesTemplate = \ | 51 self.indexListModulesTemplate = ( |
| 52 TemplatesListsStyleCSS.indexListModulesTemplate | 52 TemplatesListsStyleCSS.indexListModulesTemplate) |
| 53 self.indexListEntryTemplate = \ | 53 self.indexListEntryTemplate = ( |
| 54 TemplatesListsStyleCSS.indexListEntryTemplate | 54 TemplatesListsStyleCSS.indexListEntryTemplate) |
| 55 else: | 55 else: |
| 56 from . import TemplatesListsStyle | 56 from . import TemplatesListsStyle |
| 57 self.headerTemplate = \ | 57 self.headerTemplate = ( |
| 58 TemplatesListsStyle.headerTemplate.format(**colors) | 58 TemplatesListsStyle.headerTemplate.format(**colors)) |
| 59 self.footerTemplate = \ | 59 self.footerTemplate = ( |
| 60 TemplatesListsStyle.footerTemplate.format(**colors) | 60 TemplatesListsStyle.footerTemplate.format(**colors)) |
| 61 self.indexBodyTemplate = \ | 61 self.indexBodyTemplate = ( |
| 62 TemplatesListsStyle.indexBodyTemplate.format(**colors) | 62 TemplatesListsStyle.indexBodyTemplate.format(**colors)) |
| 63 self.indexListPackagesTemplate = \ | 63 self.indexListPackagesTemplate = ( |
| 64 TemplatesListsStyle.indexListPackagesTemplate.format(**colors) | 64 TemplatesListsStyle.indexListPackagesTemplate.format(**colors)) |
| 65 self.indexListModulesTemplate = \ | 65 self.indexListModulesTemplate = ( |
| 66 TemplatesListsStyle.indexListModulesTemplate.format(**colors) | 66 TemplatesListsStyle.indexListModulesTemplate.format(**colors)) |
| 67 self.indexListEntryTemplate = \ | 67 self.indexListEntryTemplate = ( |
| 68 TemplatesListsStyle.indexListEntryTemplate.format(**colors) | 68 TemplatesListsStyle.indexListEntryTemplate.format(**colors)) |
| 69 | 69 |
| 70 def remember(self, file, moduleDocument, basename=""): | 70 def remember(self, file, moduleDocument, basename=""): |
| 71 """ | 71 """ |
| 72 Public method to remember a documentation file. | 72 Public method to remember a documentation file. |
| 73 | 73 |
| 108 package = os.path.dirname(file).replace(os.sep, ".") | 108 package = os.path.dirname(file).replace(os.sep, ".") |
| 109 try: | 109 try: |
| 110 elt = self.packages[package] | 110 elt = self.packages[package] |
| 111 except KeyError: | 111 except KeyError: |
| 112 elt = self.packages["00index"] | 112 elt = self.packages["00index"] |
| 113 elt["modules"][moduleDocument.name()] = \ | 113 elt["modules"][moduleDocument.name()] = ( |
| 114 moduleDocument.shortDescription() | 114 moduleDocument.shortDescription()) |
| 115 | 115 |
| 116 def __writeIndex(self, packagename, package, newline=None): | 116 def __writeIndex(self, packagename, package, newline=None): |
| 117 """ | 117 """ |
| 118 Private method to generate an index file for a package. | 118 Private method to generate an index file for a package. |
| 119 | 119 |
| 167 })) | 167 })) |
| 168 modules = self.indexListModulesTemplate.format(**{ | 168 modules = self.indexListModulesTemplate.format(**{ |
| 169 "Entries": "".join(lst), | 169 "Entries": "".join(lst), |
| 170 }) | 170 }) |
| 171 | 171 |
| 172 doc = self.headerTemplate.format( | 172 doc = ( |
| 173 **{"Title": title, | 173 self.headerTemplate.format( |
| 174 "Style": self.stylesheet}) + \ | 174 **{"Title": title, |
| 175 self.indexBodyTemplate.format( | 175 "Style": self.stylesheet} |
| 176 ) + self.indexBodyTemplate.format( | |
| 176 **{"Title": title, | 177 **{"Title": title, |
| 177 "Description": package["description"], | 178 "Description": package["description"], |
| 178 "Subpackages": subpackages, | 179 "Subpackages": subpackages, |
| 179 "Modules": modules}) + \ | 180 "Modules": modules} |
| 180 self.footerTemplate | 181 ) + self.footerTemplate |
| 182 ) | |
| 181 | 183 |
| 182 f = open(filename, "w", encoding="utf-8", newline=newline) | 184 f = open(filename, "w", encoding="utf-8", newline=newline) |
| 183 f.write(doc) | 185 f.write(doc) |
| 184 f.close() | 186 f.close() |
| 185 | 187 |
