Clean up the mechanism for disabling Javascript search.

sphinx/builders/html.py

@@ -78,7 +78,8 @@ class StandaloneHTMLBuilder(Builder):
     searchindex_filename = 'searchindex.js'
     add_permalinks = True
     embedded = False  # for things like HTML help or Qt help: suppresses sidebar
-
+    search = True # for things like HTML help and Apple help: suppress search
+    
     # This is a class attribute because it is mutated by Sphinx.add_javascript.
     script_files = ['_static/jquery.js', '_static/underscore.js',
                     '_static/doctools.js']
@@ -247,14 +248,16 @@ class StandaloneHTMLBuilder(Builder):
 
     def prepare_writing(self, docnames):
         # create the search indexer
-        from sphinx.search import IndexBuilder, languages
-        lang = self.config.html_search_language or self.config.language
-        if not lang or lang not in languages:
-            lang = 'en'
-        self.indexer = IndexBuilder(self.env, lang,
-                                    self.config.html_search_options,
-                                    self.config.html_search_scorer)
-        self.load_indexer(docnames)
+        self.indexer = None
+        if self.search:
+            from sphinx.search import IndexBuilder, languages
+            lang = self.config.html_search_language or self.config.language
+            if not lang or lang not in languages:
+                lang = 'en'
+            self.indexer = IndexBuilder(self.env, lang,
+                                        self.config.html_search_options,
+                                        self.config.html_search_scorer)
+            self.load_indexer(docnames)
 
         self.docwriter = HTMLWriter(self)
         self.docsettings = OptionParser(
@@ -484,12 +487,12 @@ class StandaloneHTMLBuilder(Builder):
             self.handle_page(pagename, {}, template)
 
         # the search page
-        if self.name != 'htmlhelp':
+        if self.search:
             self.info(' search', nonl=1)
             self.handle_page('search', {}, 'search.html')
 
         # the opensearch xml file
-        if self.config.html_use_opensearch and self.name != 'htmlhelp':
+        if self.config.html_use_opensearch and self.search:
             self.info(' opensearch', nonl=1)
             fn = path.join(self.outdir, '_static', 'opensearch.xml')
             self.handle_page('opensearch', {}, 'opensearch.xml', outfilename=fn)
@@ -579,9 +582,11 @@ class StandaloneHTMLBuilder(Builder):
                 copyfile(jsfile, path.join(self.outdir, '_static',
                                            'translations.js'))
 
-        # add context items for search function used in searchtools.js_t
         ctx = self.globalcontext.copy()
-        ctx.update(self.indexer.context_for_searchtool())
+        
+        # add context items for search function used in searchtools.js_t
+        if self.indexer is not None:
+            ctx.update(self.indexer.context_for_searchtool())
 
         # then, copy over theme-supplied static files
         if self.theme:
@@ -801,7 +806,8 @@ class StandaloneHTMLBuilder(Builder):
             copyfile(self.env.doc2path(pagename), source_name)
 
     def handle_finish(self):
-        self.finish_tasks.add_task(self.dump_search_index)
+        if self.indexer:
+            self.finish_tasks.add_task(self.dump_search_index)
         self.finish_tasks.add_task(self.dump_inventory)
 
     def dump_inventory(self):

sphinx/builders/htmlhelp.py

@@ -173,6 +173,9 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder):
     # don't add sidebar etc.
     embedded = True
 
+    # don't generate search index or include search page
+    search = False
+
     lcid = 0x409
     encoding = 'cp1252'