eric: comparison DocumentationTools/QtHelpGenerator.py

-:1b59c4ba121e
+:8cd4d08fa9f6
 HelpProjectFile = 'source.qhp'
 HelpHelpFile = 'source.qch'
 HelpCollectionProjectFile = 'source.qhcp'
 HelpCollectionFile = 'collection.qhc'
 class QtHelpGenerator(object):
 """
 Class implementing the QtHelp generator for the builtin documentation generator.
 """
 def __init__(self, htmlDir,
 outputDir, namespace, virtualFolder, filterName, filterAttributes,
 title, createCollection):
 """
 Constructor
 @param htmlDir directory containing the HTML files (string)
 self.relPath = relpath(self.htmlDir, self.outputDir)
 self.title = title
 self.createCollection = createCollection
 self.packages = {
-"00index" : {
+"00index": {
-"subpackages" : {},
+"subpackages": {},
-"modules" : {}
+"modules": {}
 }
 }
 self.remembered = False
 self.keywords = []
 def remember(self, file, moduleDocument, basename=""):
 """
 Public method to remember a documentation file.
 @param file The filename to be remembered. (string)
 @param moduleDocument The ModuleDocument object containing the
 information for the file.
 @param basename The basename of the file hierarchy to be documented.
 The basename is stripped off the filename if it starts with
 the basename.
 """
 elt = self.packages["00index"]
 package = dir.replace(os.sep, ".")
 elt["subpackages"][package] = moduleDocument.name()
 self.packages[package] = {
-"subpackages" : {},
+"subpackages": {},
-"modules" : {}
+"modules": {}
 }
 kwEntry = ("{0} (Package)".format(package.split('.')[-1]),
 joinext("index-{0}".format(package), ".html"))
 if kwEntry not in self.keywords:
 self.keywords.append(kwEntry)
 if moduleDocument.isEmpty():
 except KeyError:
 elt = self.packages["00index"]
 elt["modules"][moduleDocument.name()] = moduleDocument.name()
 if "__init__" not in file:
 kwEntry = ("{0} (Module)".format(moduleDocument.name().split('.')[-1]),
 joinext(moduleDocument.name(), ".html"))
 if kwEntry not in self.keywords:
 self.keywords.append(kwEntry)
 for kw in moduleDocument.getQtHelpKeywords():
 kwEntry = (kw[0], "{0}{1}".format(
 @param level indentation level (integer)
 @return sections part (string)
 """
 indent = level * '  '
 indent1 = indent + '  '
-s  = indent + '<section title="{0}" ref="{1}">\n'.format(
+s = indent + '<section title="{0}" ref="{1}">\n'.format(
 package == "00index" and self.title or package,
 package == "00index" and \
 joinext("index", ".html") or \
 joinext("index-{0}".format(package), ".html"))
 for subpack in sorted(self.packages[package]["subpackages"]):
 s += self.__generateSections(subpack, level + 1)
 elif newline in ["\r", "\r\n"]:
 return txt.replace("\n", newline)
 else:
 return txt
-def generateFiles(self, basename = "", newline = None):
+def generateFiles(self, basename="", newline=None):
 """
 Public method to generate all index files.
 @param basename The basename of the file hierarchy to be documented.
 The basename is stripped off the filename if it starts with
 ['      <keyword name="{0}" id="{1}" ref="{2}" />'.format(
 html_encode(kw[0]), html_encode(kw[0]), html_encode(kw[1])) \
 for kw in self.keywords])
 helpAttribs = {
-"namespace" : self.namespace,
+"namespace": self.namespace,
-"folder" : self.virtualFolder,
+"folder": self.virtualFolder,
-"filter_name" : self.filterName,
+"filter_name": self.filterName,
-"filter_attributes" : filterAttribs,
+"filter_attributes": filterAttribs,
-"sections" : sections,
+"sections": sections,
-"keywords" : keywords,
+"keywords": keywords,
-"files" : files,
+"files": files,
 }
 txt = self.__convertEol(HelpProject.format(**helpAttribs), newline)
 f = open(os.path.join(self.outputDir, HelpProjectFile), "w",
-encoding = "utf-8", newline = newline)
+encoding="utf-8", newline=newline)
 f.write(txt)
 f.close()
 if self.createCollection and \
 not os.path.exists(os.path.join(self.outputDir, HelpCollectionProjectFile)):
 collectionAttribs = {
-"helpfile" : HelpHelpFile,
+"helpfile": HelpHelpFile,
 }
 txt = self.__convertEol(HelpCollection.format(**collectionAttribs), newline)
 f = open(os.path.join(self.outputDir, HelpCollectionProjectFile),
-"w", encoding = "utf-8", newline = newline)
+"w", encoding="utf-8", newline=newline)
 f.write(txt)
 f.close()
 sys.stdout.write("QtHelp files written.\n")
 sys.stdout.write("Generating QtHelp documentation...\n")
 cwd = os.getcwd()
 # generate the compressed files
 shutil.copy(os.path.join(self.outputDir, HelpProjectFile), self.htmlDir)
 os.chdir(self.htmlDir)
 subprocess.call(["qhelpgenerator", "source.qhp",
 "-o", os.path.join(self.outputDir, HelpHelpFile)])
 os.remove(HelpProjectFile)
 if self.createCollection:
 sys.stdout.write("Generating QtHelp collection...\n")

Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/QtHelpGenerator.py

DocumentationTools/QtHelpGenerator.py