From 0209919fc28c14fea5606d7240cd3f1dab2552f9 Mon Sep 17 00:00:00 2001
From: Yuri Sizov <yuris@humnom.net>
Date: Mon, 21 Nov 2022 22:13:24 +0300
Subject: [PATCH] Remove search highlights from the page and the history

Co-authored-by: the-sink <lucianedean@gmail.com>
---
 _static/css/custom.css | 11 ++++++++++-
 _static/js/custom.js   |  8 ++++++++
 conf.py                |  4 ++--
 3 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/_static/css/custom.css b/_static/css/custom.css
index b8e34572a94..9d72750f31a 100644
--- a/_static/css/custom.css
+++ b/_static/css/custom.css
@@ -1090,12 +1090,21 @@ kbd.compound > .kbd,
     background-color: var(--navbar-current-background-color-active);
 }
 
-/* Hide the obnoxious automatic highlight in search results */
+/* Hide the obnoxious automatic highlight from the search context. */
 .rst-content .highlighted {
     background-color: transparent;
+    box-shadow: none;
     font-weight: inherit;
     padding: 0;
 }
+/* Still slightly highlight matched parts on the dedicated search results page. */
+.rst-content #search-results .highlighted {
+    background-color: #ffcd0029;
+    border-radius: 2px;
+    color: var(--body-color);
+    font-weight: 600;
+    padding: 0 3px;
+}
 
 /* Allows the scrollbar to be shown in the sidebar */
 @media only screen and (min-width: 769px) {
diff --git a/_static/js/custom.js b/_static/js/custom.js
index 4f849541dad..861d38cecf6 100644
--- a/_static/js/custom.js
+++ b/_static/js/custom.js
@@ -233,6 +233,14 @@ const registerSidebarObserver = (function(){
 })();
 
 $(document).ready(() => {
+  // Remove the search match highlights from the page, and adjust the URL in the
+  // navigation history.
+  const url = new URL(location.href);
+  if (url.searchParams.has('highlight')) {
+    Documentation.hideSearchWords();
+  }
+
+  // Initialize handlers for page scrolling and our custom sidebar.
   const mediaQuery = window.matchMedia('only screen and (min-width: 769px)');
 
   registerOnScrollEvent(mediaQuery);
diff --git a/conf.py b/conf.py
index 31f22085e7a..859413979b1 100644
--- a/conf.py
+++ b/conf.py
@@ -189,14 +189,14 @@
 html_css_files = [
     'css/algolia.css',
     'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css',
-    "css/custom.css?2", # Increment the number at the end when the file changes to bust the cache.
+    "css/custom.css?3", # Increment the number at the end when the file changes to bust the cache.
 ]
 
 if not on_rtd:
     html_css_files.append("css/dev.css")
 
 html_js_files = [
-    "js/custom.js?1", # Increment the number at the end when the file changes to bust the cache.
+    "js/custom.js?2", # Increment the number at the end when the file changes to bust the cache.
     ('https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js', {'defer': 'defer'}),
     ('js/algolia.js', {'defer': 'defer'})
 ]