IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Save search resul score to HTML element for debugging (#10718)

Browse Source 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
Martin Liška 2022-09-09 04:06:55 +02:00 committed by GitHub
parent c5ae5855ae
commit 454ced9cc1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -20,6 +20,7 @@ Features added
* #10781: Allow :rst:role:`ref` role to be used with definitions and fields. * #10781: Allow :rst:role:`ref` role to be used with definitions and fields.
* #10717: HTML Search: Increase priority for full title and * #10717: HTML Search: Increase priority for full title and
subtitle matches in search results subtitle matches in search results
* #10718: HTML Search: Save search result score to the HTML element for debugging
Bugs fixed Bugs fixed
---------- ----------

3
sphinx/themes/basic/static/searchtools.js
View File

@ -64,7 +64,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const [docName, title, anchor, descr] = item; const [docName, title, anchor, descr, score, _filename] = item;
let listItem = document.createElement("li"); let listItem = document.createElement("li");
let requestUrl; let requestUrl;
@ -86,6 +86,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
params.set("highlight", [...highlightTerms].join(" ")); params.set("highlight", [...highlightTerms].join(" "));
let linkEl = listItem.appendChild(document.createElement("a")); let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + "?" + params.toString() + anchor; linkEl.href = linkUrl + "?" + params.toString() + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title; linkEl.innerHTML = title;
if (descr) if (descr)
listItem.appendChild(document.createElement("span")).innerHTML = listItem.appendChild(document.createElement("span")).innerHTML =