I spent some time looking into this today, and here's what I've found so far:

sphinx search was intentionally disabled in #1934 (comment) , recommending folks use public search engines with site-scoping.
While that's not a bad solution, it's not advertised anywhere user-facing, and implementing a search box on the site that would use a public (maybe even popular) search engine may be counter to some folks' desires to keep their searches private, and I'd hate to drag people into a weird search.

I tried reenabling sphinx search, and it's not too bad of a change, but since the general approach sphinx "wants" is to have a theme that extends an existing one (like basic) to inject the right JS snippets, so in order to make this work we'd need to either vendor the JS or figure our a smart JS loader from the pre-packed code - I couldn't figure that out yet.

Largely, it comes from here:

peps/pep_sphinx_extensions/pep_processor/html/pep_html_builder.py

Lines 9 to 23 in 1fb889b

    
           class FileBuilder(StandaloneHTMLBuilder): 
        
               copysource = False  # Prevent unneeded source copying - we link direct to GitHub 
        
               search = False  # Disable search 
        
               # Things we don't use but that need to exist: 
        
               indexer = None 
        
               relations = {} 
        
               _script_files = _css_files = [] 
        
               globalcontext = {"script_files": [], "css_files": []} 
        
               def prepare_writing(self, _doc_names: set[str]) -> None: 
        
                   self.docwriter = HTMLWriter(self) 
        
                   _opt_parser = OptionParser([self.docwriter], defaults=self.env.settings, read_config_files=True) 
        
                   self.docsettings = _opt_parser.get_default_values() 
        
                   self._orig_css_files = self._orig_js_files = []

I'd be happy to continue to poke at this if there's continued interest in having a PEP web search, and don't want to invest the effort if it's not going to pass a review ;)

	class FileBuilder(StandaloneHTMLBuilder):
	copysource = False # Prevent unneeded source copying - we link direct to GitHub
	search = False # Disable search

	# Things we don't use but that need to exist:
	indexer = None
	relations = {}
	_script_files = _css_files = []
	globalcontext = {"script_files": [], "css_files": []}

	def prepare_writing(self, _doc_names: set[str]) -> None:
	self.docwriter = HTMLWriter(self)
	_opt_parser = OptionParser([self.docwriter], defaults=self.env.settings, read_config_files=True)
	self.docsettings = _opt_parser.get_default_values()
	self._orig_css_files = self._orig_js_files = []

Uh oh!

Infra: Add search to the PEP index #4083

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.