eric: comparison DocumentationTools/QtHelpGenerator.py

-:9986ec0e559a
+:10516539f238
 # Copyright (c) 2009 - 2013 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 """
-Module implementing the QtHelp generator for the builtin documentation generator.
+Module implementing the QtHelp generator for the builtin documentation
+generator.
 """
 from __future__ import unicode_literals    # __IGNORE_WARNING__
 import sys
 HelpCollectionFile = 'collection.qhc'
 class QtHelpGenerator(object):
 """
-Class implementing the QtHelp generator for the builtin documentation generator.
+Class implementing the QtHelp generator for the builtin documentation
+generator.
 """
 def __init__(self, htmlDir,
-outputDir, namespace, virtualFolder, filterName, filterAttributes,
+outputDir, namespace, virtualFolder, filterName,
-title, createCollection):
+filterAttributes, title, createCollection):
 """
 Constructor
 @param htmlDir directory containing the HTML files (string)
 @param outputDir output directory for the files (string)
 @param namespace namespace to be used (string)
 @param virtualFolder virtual folder to be used (string)
 @param filterName name of the custom filter (string)
-@param filterAttributes ':' separated list of filter attributes (string)
+@param filterAttributes ':' separated list of filter attributes
+(string)
 @param title title to be used for the generated help (string)
-@param createCollection flag indicating the generation of the collection
+@param createCollection flag indicating the generation of the
-files (boolean)
+collection files (boolean)
 """
 self.htmlDir = htmlDir
 self.outputDir = outputDir
 self.namespace = namespace
 self.virtualFolder = virtualFolder
 self.filterName = filterName
-self.filterAttributes = filterAttributes and filterAttributes.split(':') or []
+self.filterAttributes = \
+filterAttributes and filterAttributes.split(':') or []
 self.relPath = relpath(self.htmlDir, self.outputDir)
 self.title = title
 self.createCollection = createCollection
 self.packages = {
 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]),
+kwEntry = (
-joinext(moduleDocument.name(), ".html"))
+"{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(
 joinext(moduleDocument.name(), ".html"), kw[1]))
 basename = basename.replace(os.sep, ".")
 if not basename.endswith("."):
 basename = "{0}.".format(basename)
 sections = self.__generateSections("00index", 3)
-filesList = sorted([e for e in os.listdir(self.htmlDir) if e.endswith('.html')])
+filesList = sorted(
-files = "\n".join(["      <file>{0}</file>".format(f) for f in filesList])
+[e for e in os.listdir(self.htmlDir) if e.endswith('.html')])
-filterAttribs = "\n".join(["    <filterAttribute>{0}</filterAttribute>".format(a) \
+files = "\n".join(
-for a in sorted(self.filterAttributes)])
+["      <file>{0}</file>".format(f) for f in filesList])
+filterAttribs = "\n".join(
+["    <filterAttribute>{0}</filterAttribute>".format(a)
+for a in sorted(self.filterAttributes)])
 keywords = "\n".join(
 ['      <keyword name="{0}" id="{1}" ref="{2}" />'.format(
-html_encode(kw[0]), html_encode(kw[0]), html_encode(kw[1])) \
+html_encode(kw[0]), html_encode(kw[0]), html_encode(kw[1]))
 for kw in sorted(self.keywords)])
 helpAttribs = {
 "namespace": self.namespace,
 "folder": self.virtualFolder,
 encoding="utf-8", newline=newline)
 f.write(txt)
 f.close()
 if self.createCollection and \
-not os.path.exists(os.path.join(self.outputDir, HelpCollectionProjectFile)):
+not os.path.exists(
+os.path.join(self.outputDir, HelpCollectionProjectFile)):
 collectionAttribs = {
 "helpfile": HelpHelpFile,
 }
-txt = self.__convertEol(HelpCollection.format(**collectionAttribs), newline)
+txt = self.__convertEol(
+HelpCollection.format(**collectionAttribs), newline)
 f = open(os.path.join(self.outputDir, HelpCollectionProjectFile),
 "w", encoding="utf-8", newline=newline)
 f.write(txt)
 f.close()
 sys.stdout.flush()
 sys.stderr.flush()
 cwd = os.getcwd()
 # generate the compressed files
-shutil.copy(os.path.join(self.outputDir, HelpProjectFile), self.htmlDir)
+shutil.copy(
+os.path.join(self.outputDir, HelpProjectFile), self.htmlDir)
 os.chdir(self.htmlDir)
-subprocess.call([os.path.join(getQtBinariesPath(), "qhelpgenerator"),
+subprocess.call([
-"source.qhp", "-o", os.path.join(self.outputDir, HelpHelpFile)])
+os.path.join(getQtBinariesPath(), "qhelpgenerator"),
+"source.qhp", "-o", os.path.join(self.outputDir, HelpHelpFile)])
 os.remove(HelpProjectFile)
 if self.createCollection:
 sys.stdout.write("Generating QtHelp collection...\n")
 sys.stdout.flush()
 sys.stderr.flush()
 os.chdir(self.outputDir)
-subprocess.call([os.path.join(getQtBinariesPath(), "qcollectiongenerator"),
+subprocess.call([
-"source.qhcp", "-o", "collection.qhc"])
+os.path.join(getQtBinariesPath(), "qcollectiongenerator"),
+"source.qhcp", "-o", "collection.qhc"])
 os.chdir(cwd)

Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/QtHelpGenerator.py

DocumentationTools/QtHelpGenerator.py