docs: update to sphinx 5.1 (#565)

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com>
DisnakeDev · Jul 26, 2022 · d0a2855 · d0a2855
1 parent 550f2e3
commit d0a2855
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 574 deletions.
diff --git a/changelog/565.doc.rst b/changelog/565.doc.rst
@@ -0,0 +1 @@
+Update sphinx from 4.5.0 to version 5.1, and take advantage of new options.
diff --git a/docs/_static/custom.js b/docs/_static/custom.js
@@ -59,7 +59,6 @@ let showHideSidebar;
 document.addEventListener('DOMContentLoaded', () => {
   mobileSearch = new SearchBar();
 
-
   const search_box = document.querySelector(".search input[type='search']");
   const updateSearchPlaceholder = function() {
     if (window.matchMedia && window.matchMedia('(max-width: 600px)').matches) {
@@ -215,25 +214,25 @@ document.addEventListener('DOMContentLoaded', () => {
 
 
 function focusSearch() {
-  $('input[name=q]').first().focus();
+  document.querySelector("input[name=q]")?.focus();
 }
 
 
 function unfocusSearch() {
-  $('input[name=q]').first().blur();
+  document.querySelector("input[name=q]")?.blur();
 }
 
 
-$(document).keydown((event) => {
+document.addEventListener("keydown", (event) => {
   if (event.altKey || event.metaKey)
     return;
 
   const focusedElement = document.activeElement;
   if (["TEXTAREA", "INPUT", "SELECT", "BUTTON"].includes(focusedElement.tagName)) {
     // handle `escape` in search field
-    if (!event.ctrlKey && !event.shiftKey && event.key === "Escape" && $('input[name=q]').first().is(focusedElement)) {
+    if (!event.ctrlKey && !event.shiftKey && event.key === "Escape" && document.querySelector("input[name=q]") === focusedElement) {
       unfocusSearch();
-      return false;
+      return event.preventDefault();
     }
     // otherwise, ignore all key presses in inputs
     return;
@@ -243,25 +242,37 @@ $(document).keydown((event) => {
     // close modal using `escape`, if modal exists
     if (event.key === "Escape" && activeModal) {
       activeModal.close();
-      return false;
+      return event.preventDefault();
     }
 
     // focus search using `s` (`/` is already supported by Sphinx)
     if (event.key === "s") {
       focusSearch();
-      return false;
+      return event.preventDefault();
     }
   }
 
   // focus search using `ctrl+k`
   if (!event.shiftKey && event.ctrlKey && event.key == "k") {
     focusSearch();
-    return false;
+    return event.preventDefault();
   }
 });
 
-$(document).ready(function () {
-  $('a.external').attr('target', '_blank');
+
+const _doc_ready = (callback) => {
+  if (document.readyState !== "loading") {
+    callback();
+  } else {
+    document.addEventListener("DOMContentLoaded", callback);
+  }
+};
+
+
+_doc_ready(() => {
+  document.querySelectorAll("a.external").forEach((a) => {
+    a.setAttribute("target", "_blank");
+  })
 });
 
 var url = new URL(window.location.href);

diff --git a/docs/_static/scorer.js b/docs/_static/scorer.js
@@ -1,7 +1,7 @@
 'use-strict';
 
-let queryBeingDone = null;
-let pattern = null;
+let queryBeingDone = undefined;
+let pattern = undefined;
 
 const escapedRegex = /[-\/\\^$*+?.()|[\]{}]/g;
 function escapeRegex(e) {
@@ -23,14 +23,28 @@ function __cleanNamespaces(query) {
     return query.replace(/(disnake\.(ext\.)?)?(.+)/, '$3');
 }
 
-Scorer = {
+function __setPattern() {
+    const params = new URLSearchParams(window.location.search);
+    queryBeingDone = params.get('q');
+    if (queryBeingDone) {
+        pattern = new RegExp(Array.from(queryBeingDone).map(escapeRegex).join('.*?'), 'i');
+    } else {
+        queryBeingDone = null;
+        pattern = null;
+    }
+}
 
+Scorer = {
     // Implement the following function to further tweak the score for each result
     // The function takes a result array [filename, title, anchor, descr, score]
     // and returns the new score.
     score: (result) => {
         // only inflate the score of things that are actual API reference things
-        const [, title, , , score] = result;
+        const [, title, , , score,] = result;
+
+        if (queryBeingDone === undefined) {
+            __setPattern();
+        }
 
         if (pattern !== null && title.startsWith('disnake.')) {
             let _score = __score(title, pattern);
@@ -64,12 +78,3 @@ Scorer = {
     term: 5,
     partialTerm: 2
 };
-
-document.addEventListener('DOMContentLoaded', () => {
-    const params = new URLSearchParams(window.location.search);
-    queryBeingDone = params.get('q');
-    if (queryBeingDone) {
-        let _pattern = Array.from(queryBeingDone).map(escapeRegex).join('.*?');
-        pattern = new RegExp(_pattern, 'i');
-    }
-});