Deploying to gh-pages from @ 2029446 🚀

stfc · Feb 23, 2024 · f584dac · f584dac
1 parent a3693a7
commit f584dac
Show file tree

Hide file tree

Showing 20 changed files with 160 additions and 144 deletions.
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -17,7 +17,7 @@ example configuration:
 
   repos:
       - repo: https://github.com/stfc/pre-commit-hooks
-        rev: v0.3.2
+        rev: v0.3.5
         hooks:
           - id: check-mypy-import-errors
           - id: check-pylint-import-errors

diff --git a/_static/basic.css b/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -757,6 +757,7 @@ span.pre {
     -ms-hyphens: none;
     -webkit-hyphens: none;
     hyphens: none;
+    white-space: nowrap;
 }
 
 div[class*="highlight-"] {

diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css
diff --git a/_static/css/theme.css b/_static/css/theme.css
diff --git a/_static/doctools.js b/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -154,9 +154,7 @@ var Documentation = {
     this.fixFirefoxAnchorBug();
     this.highlightSearchWords();
     this.initIndexTable();
-    if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
-      this.initOnKeyListeners();
-    }
+    this.initOnKeyListeners();
   },
 
   /**
@@ -264,6 +262,16 @@ var Documentation = {
   hideSearchWords : function() {
     $('#searchbox .highlight-link').fadeOut(300);
     $('span.highlighted').removeClass('highlighted');
+    var url = new URL(window.location);
+    url.searchParams.delete('highlight');
+    window.history.replaceState({}, '', url);
+  },
+
+   /**
+   * helper function to focus on search bar
+   */
+  focusSearchBar : function() {
+    $('input[name=q]').first().focus();
   },
 
   /**
@@ -288,27 +296,54 @@ var Documentation = {
   },
 
   initOnKeyListeners: function() {
+    // only install a listener if it is really needed
+    if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+        !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+        return;
+
     $(document).keydown(function(event) {
       var activeElementType = document.activeElement.tagName;
       // don't navigate when in search box, textarea, dropdown or button
       if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
-          && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
-          && !event.shiftKey) {
-        switch (event.keyCode) {
-          case 37: // left
-            var prevHref = $('link[rel="prev"]').prop('href');
-            if (prevHref) {
-              window.location.href = prevHref;
-              return false;
-            }
-            break;
-          case 39: // right
-            var nextHref = $('link[rel="next"]').prop('href');
-            if (nextHref) {
-              window.location.href = nextHref;
-              return false;
-            }
-            break;
+          && activeElementType !== 'BUTTON') {
+        if (event.altKey || event.ctrlKey || event.metaKey)
+          return;
+
+          if (!event.shiftKey) {
+            switch (event.key) {
+              case 'ArrowLeft':
+                if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+                  break;
+                var prevHref = $('link[rel="prev"]').prop('href');
+                if (prevHref) {
+                  window.location.href = prevHref;
+                  return false;
+                }
+                break;
+              case 'ArrowRight':
+                if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+                  break;
+                var nextHref = $('link[rel="next"]').prop('href');
+                if (nextHref) {
+                  window.location.href = nextHref;
+                  return false;
+                }
+                break;
+              case 'Escape':
+                if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+                  break;
+                Documentation.hideSearchWords();
+                return false;
+          }
+        }
+
+        // some keyboard layouts may need Shift to get /
+        switch (event.key) {
+          case '/':
+            if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+              break;
+            Documentation.focusSearchBar();
+            return false;
         }
       }
     });

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -8,5 +8,7 @@ var DOCUMENTATION_OPTIONS = {
     LINK_SUFFIX: '.html',
     HAS_SOURCE: true,
     SOURCELINK_SUFFIX: '.txt',
-    NAVIGATION_WITH_KEYS: false
+    NAVIGATION_WITH_KEYS: false,
+    SHOW_SEARCH_SUMMARY: true,
+    ENABLE_SEARCH_SHORTCUTS: true,
 };
diff --git a/_static/language_data.js b/_static/language_data.js
@@ -5,7 +5,7 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/_static/pygments.css b/_static/pygments.css
@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #E40000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #008400 } /* Generic.Inserted */

diff --git a/_static/searchtools.js b/_static/searchtools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -172,10 +172,6 @@ var Search = {
       }
       // stem the word
       var word = stemmer.stemWord(tmp[i].toLowerCase());
-      // prevent stemmer from cutting word smaller than two chars
-      if(word.length < 3 && tmp[i].length >= 3) {
-        word = tmp[i];
-      }
       var toAppend;
       // select the correct list
       if (word[0] == '-') {
@@ -276,7 +272,7 @@ var Search = {
           setTimeout(function() {
             displayNextItem();
           }, 5);
-        } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
+        } else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) {
           $.ajax({url: requestUrl,
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {
@@ -293,7 +289,7 @@ var Search = {
                     }, 5);
                   }});
         } else {
-          // no source available, just display title
+          // just display title
           Search.output.append(listItem);
           setTimeout(function() {
             displayNextItem();

diff --git a/genindex.html b/genindex.html
@@ -24,12 +24,16 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search"  style="background: #007681" >
-            <a href="index.html">
-            <img src="_static/hartree_logo.png" class="logo" alt="Logo"/>
+
+
+
+          <a href="index.html">
+
+              <img src="_static/hartree_logo.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -63,8 +67,8 @@
         <div class="rst-content style-external-links">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Index</li>
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Index</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>
@@ -111,8 +115,6 @@ <h2 id="C">C</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="hooks/check_mypy_imports.html#hooks.check_mypy_import_errors.CheckMypyImportErrors">CheckMypyImportErrors (class in hooks.check_mypy_import_errors)</a>
-</li>
-      <li><a href="hooks/check_pylint_imports.html#hooks.check_pylint_import_errors.CheckPylintImportErrors">CheckPylintImportErrors (class in hooks.check_pylint_import_errors)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -139,13 +141,6 @@ <h2 id="H">H</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li>
-    hooks.check_pylint_import_errors
-
-      <ul>
-        <li><a href="hooks/check_pylint_imports.html#module-hooks.check_pylint_import_errors">module</a>
-</li>
-      </ul></li>
-      <li>
     hooks.utils.hook
 
       <ul>
@@ -177,8 +172,6 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="hooks/check_mypy_imports.html#hooks.check_mypy_import_errors.main">(in module hooks.check_mypy_import_errors)</a>
-</li>
-        <li><a href="hooks/check_pylint_imports.html#hooks.check_pylint_import_errors.main">(in module hooks.check_pylint_import_errors)</a>
 </li>
       </ul></li>
       <li>
@@ -188,8 +181,6 @@ <h2 id="M">M</h2>
         <li><a href="hooks/check_missing_requirements.html#module-hooks.check_missing_requirements">hooks.check_missing_requirements</a>
 </li>
         <li><a href="hooks/check_mypy_imports.html#module-hooks.check_mypy_import_errors">hooks.check_mypy_import_errors</a>
-</li>
-        <li><a href="hooks/check_pylint_imports.html#module-hooks.check_pylint_import_errors">hooks.check_pylint_import_errors</a>
 </li>
         <li><a href="utils/hook.html#module-hooks.utils.hook">hooks.utils.hook</a>
 </li>
@@ -214,8 +205,6 @@ <h2 id="R">R</h2>
 
       <ul>
         <li><a href="hooks/check_mypy_imports.html#hooks.check_mypy_import_errors.CheckMypyImportErrors.run">(hooks.check_mypy_import_errors.CheckMypyImportErrors method)</a>
-</li>
-        <li><a href="hooks/check_pylint_imports.html#hooks.check_pylint_import_errors.CheckPylintImportErrors.run">(hooks.check_pylint_import_errors.CheckPylintImportErrors method)</a>
 </li>
         <li><a href="utils/hook.html#hooks.utils.hook.Hook.run">(hooks.utils.hook.Hook method)</a>
 </li>

diff --git a/hooks/check_missing_requirements.html b/hooks/check_missing_requirements.html
@@ -27,12 +27,16 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search"  style="background: #007681" >
-            <a href="../index.html">
-            <img src="../_static/hartree_logo.png" class="logo" alt="Logo"/>
+
+
+
+          <a href="../index.html">
+
+              <img src="../_static/hartree_logo.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -66,8 +70,8 @@
         <div class="rst-content style-external-links">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Check Missing Requirements</li>
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Check Missing Requirements</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/hooks/check_missing_requirements.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/hooks/check_mypy_imports.html b/hooks/check_mypy_imports.html
@@ -27,12 +27,16 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search"  style="background: #007681" >
-            <a href="../index.html">
-            <img src="../_static/hartree_logo.png" class="logo" alt="Logo"/>
+
+
+
+          <a href="../index.html">
+
+              <img src="../_static/hartree_logo.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -66,8 +70,8 @@
         <div class="rst-content style-external-links">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Check MyPy Import Errors</li>
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Check MyPy Import Errors</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/hooks/check_mypy_imports.rst.txt" rel="nofollow"> View page source</a>
       </li>