builder: Use template for generating .qhcp file

sphinx/builders/qthelp.py

@@ -19,12 +19,14 @@ from docutils import nodes
 from six import text_type
 
 from sphinx import addnodes
+from sphinx import package_dir
 from sphinx.builders.html import StandaloneHTMLBuilder
 from sphinx.config import string_classes
 from sphinx.environment.adapters.indexentries import IndexEntries
 from sphinx.util import force_decode, logging
 from sphinx.util.osutil import make_filename
 from sphinx.util.pycompat import htmlescape
+from sphinx.util.template import SphinxRenderer
 
 if False:
     # For type annotation
@@ -38,34 +40,6 @@ logger = logging.getLogger(__name__)
 _idpattern = re.compile(
     r'(?P<title>.+) (\((class in )?(?P<id>[\w\.]+)( (?P<descr>\w+))?\))$')
 
-
-# Qt Help Collection Project (.qhcp).
-# Is the input file for the help collection generator.
-# It contains references to compressed help files which should be
-# included in the collection.
-# It may contain various other information for customizing Qt Assistant.
-collection_template = u'''\
-<?xml version="1.0" encoding="utf-8" ?>
-<QHelpCollectionProject version="1.0">
-    <assistant>
-        <title>%(title)s</title>
-        <homePage>%(homepage)s</homePage>
-        <startPage>%(startpage)s</startPage>
-    </assistant>
-    <docFiles>
-        <generate>
-            <file>
-                <input>%(outname)s.qhp</input>
-                <output>%(outname)s.qch</output>
-            </file>
-        </generate>
-        <register>
-            <file>%(outname)s.qch</file>
-        </register>
-    </docFiles>
-</QHelpCollectionProject>
-'''
-
 # Qt Help Project (.qhp)
 # This is the input file for the help generator.
 # It contains the table of contents, indices and references to the
@@ -102,6 +76,12 @@ section_template = '<section title="%(title)s" ref="%(ref)s"/>'
 file_template = ' ' * 12 + '<file>%(filename)s</file>'
 
 
+def render_file(filename, **kwargs):
+    # type: (unicode, Any) -> unicode
+    pathname = os.path.join(package_dir, 'templates', 'qthelp', filename)
+    return SphinxRenderer.render_from_file(pathname, kwargs)
+
+
 class QtHelpBuilder(StandaloneHTMLBuilder):
     """
     Builder that also outputs Qt help project, contents and index files.
@@ -232,11 +212,10 @@ class QtHelpBuilder(StandaloneHTMLBuilder):
 
         logger.info('writing collection project file...')
         with codecs.open(path.join(outdir, outname + '.qhcp'), 'w', 'utf-8') as f:  # type: ignore  # NOQA
-            f.write(collection_template % {
-                'outname': htmlescape(outname),
-                'title': htmlescape(self.config.html_short_title),
-                'homepage': htmlescape(homepage),
-                'startpage': htmlescape(startpage)})
+            content = render_file('project.qhcp', outname=outname,
+                                  title=self.config.html_short_title,
+                                  homepage=homepage, startpage=startpage)
+            f.write(content)
 
     def isdocnode(self, node):
         # type: (nodes.Node) -> bool

sphinx/templates/qthelp/project.qhcp

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<QHelpCollectionProject version="1.0">
+    <assistant>
+        <title>{{ title|e }}</title>
+        <homePage>{{ homepage|e }}</homePage>
+        <startPage>{{ startpage|e }}</startPage>
+    </assistant>
+    <docFiles>
+        <generate>
+            <file>
+                <input>{{ outname|e }}.qhp</input>
+                <output>{{ outname|e }}.qch</output>
+            </file>
+        </generate>
+        <register>
+            <file>{{ outname|e }}.qch</file>
+        </register>
+    </docFiles>
+</QHelpCollectionProject>

tests/test_build_qthelp.py

@@ -71,4 +71,4 @@ def test_qthelp_title(app, status, warning):
     assert '<section title="Sphinx &lt;b&gt;"full"&lt;/b&gt; title" ref="index.html">' in qhp
 
     qhcp = (app.outdir / 'Python.qhcp').text()
-    assert '<title>Sphinx &lt;b&gt;"short"&lt;/b&gt; title</title>' in qhcp
+    assert '<title>Sphinx &lt;b&gt;&#34;short&#34;&lt;/b&gt; title</title>' in qhcp