Boost title-matching scores if main title

Related to sphinx-doc#12391. Intended as a proof of concept, not a full solution.
wlach · May 25, 2024 · fbb62cf · fbb62cf
1 parent 48cbb43
commit fbb62cf
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/sphinx/themes/basic/static/searchtools.js b/sphinx/themes/basic/static/searchtools.js
@@ -328,10 +328,14 @@ const Search = {
  for (const [title, foundTitles] of Object.entries(allTitles)) {
  if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
  for (const [file, id] of foundTitles) {
- let score = Math.round(100 * queryLower.length / title.length)
+ let isMainTitle = titles[file] === title
+ // score these a little bit above document matches, with more of a boost
+ // for main document titles
+ let baseScore = Scorer.title + (isMainTitle ? 2 : 1)
+ let score = Math.round(baseScore * queryLower.length / title.length)
  normalResults.push([
  docNames[file],
- titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ isMainTitle ? title : `${titles[file]} > ${title}`,
  id !== null ? "#" + id : "",
  null,
  score,