Updated documentation

KentoNishi · Sep 25, 2024 · d58c450 · d58c450
1 parent b6c0602
commit d58c450
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 69 deletions.
diff --git a/404.html b/404.html
@@ -8,15 +8,14 @@
     <title>Torch Pitch Shift Docs</title>
     <link rel="stylesheet" href="/torch-pitch-shift/css/theme.css" />
     <link rel="stylesheet" href="/torch-pitch-shift/css/theme_extra.css" />
-        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
         <link href="/torch-pitch-shift/index.css" rel="stylesheet" />
 
-    <script src="/torch-pitch-shift/js/jquery-3.6.0.min.js" defer></script>
     <!--[if lt IE 9]>
       <script src="/torch-pitch-shift/js/html5shiv.min.js"></script>
     <![endif]-->
-      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
-      <script>hljs.initHighlightingOnLoad();</script> 
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+      <script>hljs.highlightAll();</script> 
 </head>
 
 <body class="wy-body-for-nav" role="document">
@@ -28,7 +27,7 @@
           <a href="/torch-pitch-shift/." class="icon icon-home"> Torch Pitch Shift Docs
         </a><div role="search">
   <form id ="rtd-search-form" class="wy-form" action="/torch-pitch-shift//search.html" method="get">
-      <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
+      <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
   </form>
 </div>
       </div>
@@ -55,7 +54,7 @@
       <div class="wy-nav-content">
         <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
-    <li><a href="/torch-pitch-shift/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
+    <li><a href="/torch-pitch-shift/." class="icon icon-home" aria-label="Docs"></a></li>
     <li class="wy-breadcrumbs-aside">
     </li>
   </ul>
@@ -96,14 +95,15 @@ <h1 id="404-page-not-found">404</h1>
 
   </span>
 </div>
-    <script>var base_url = '/torch-pitch-shift/';</script>
-    <script src="/torch-pitch-shift/js/theme_extra.js" defer></script>
-    <script src="/torch-pitch-shift/js/theme.js" defer></script>
-      <script src="/torch-pitch-shift/search/main.js" defer></script>
-    <script defer>
-        window.onload = function () {
+    <script src="/torch-pitch-shift/js/jquery-3.6.0.min.js"></script>
+    <script>var base_url = "/torch-pitch-shift/";</script>
+    <script src="/torch-pitch-shift/js/theme_extra.js"></script>
+    <script src="/torch-pitch-shift/js/theme.js"></script>
+      <script src="/torch-pitch-shift/search/main.js"></script>
+    <script>
+        jQuery(function () {
             SphinxRtdTheme.Navigation.enable(true);
-        };
+        });
     </script>
 
 </body>

diff --git a/css/theme.css b/css/theme.css
diff --git a/css/theme_extra.css b/css/theme_extra.css
@@ -103,7 +103,7 @@ pre .cs, pre .c {
 form .search-query {
     width: 100%;
     border-radius: 50px;
-    padding: 6px 12px;  /* csslint allow: box-model */
+    padding: 6px 12px;
     border-color: #D1D4D5;
 }
 
@@ -135,7 +135,7 @@ form .search-query {
 }
 
 td, th {
-    border: 1px solid #e1e4e5 !important; /* csslint allow: important */
+    border: 1px solid #e1e4e5 !important;
     border-collapse: collapse;
 }
 
@@ -155,6 +155,12 @@ td, th {
     padding-bottom: 40px;
 }
 
+/* For section-index only */
+.wy-menu-vertical .current-section p {
+    background-color: #e3e3e3;
+    color: #404040;
+}
+
 /*
  * The second step of above amendment: Here we make sure the items are aligned
  * correctly within the .rst-current-version container. Using flexbox, we

diff --git a/dist/torch_pitch_shift-1.2.5-py3-none-any.whl b/dist/torch_pitch_shift-1.2.5-py3-none-any.whl
diff --git a/dist/torch_pitch_shift-1.2.5.tar.gz b/dist/torch_pitch_shift-1.2.5.tar.gz
diff --git a/index.html b/index.html
@@ -8,7 +8,7 @@
     <title>Torch Pitch Shift Docs</title>
     <link rel="stylesheet" href="css/theme.css" />
     <link rel="stylesheet" href="css/theme_extra.css" />
-        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
         <link href="index.css" rel="stylesheet" />
 
       <script>
@@ -18,12 +18,11 @@
         var mkdocs_page_url = "/torch-pitch-shift/";
       </script>
 
-    <script src="js/jquery-3.6.0.min.js" defer></script>
     <!--[if lt IE 9]>
       <script src="js/html5shiv.min.js"></script>
     <![endif]-->
-      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
-      <script>hljs.initHighlightingOnLoad();</script> 
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+      <script>hljs.highlightAll();</script> 
 </head>
 
 <body class="wy-body-for-nav" role="document">
@@ -35,14 +34,14 @@
           <a href="." class="icon icon-home"> Torch Pitch Shift Docs
         </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" title="Type search term here" />
+      <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
   </form>
 </div>
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href=".">About</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">About</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#what-is-torch-pitch-shift">What is torch-pitch-shift?</a>
     </li>
@@ -66,8 +65,8 @@
       <div class="wy-nav-content">
         <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
-    <li><a href="." class="icon icon-home" alt="Docs"></a> &raquo;</li>
-      <li>About</li>
+    <li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
+      <li class="breadcrumb-item active">About</li>
     <li class="wy-breadcrumbs-aside">
     </li>
   </ul>
@@ -118,20 +117,21 @@ <h2 id="what-is-torch-pitch-shift">What is <code>torch-pitch-shift</code>?</h2>
 
   </span>
 </div>
-    <script>var base_url = '.';</script>
-    <script src="js/theme_extra.js" defer></script>
-    <script src="js/theme.js" defer></script>
-      <script src="search/main.js" defer></script>
-    <script defer>
-        window.onload = function () {
+    <script src="js/jquery-3.6.0.min.js"></script>
+    <script>var base_url = ".";</script>
+    <script src="js/theme_extra.js"></script>
+    <script src="js/theme.js"></script>
+      <script src="search/main.js"></script>
+    <script>
+        jQuery(function () {
             SphinxRtdTheme.Navigation.enable(true);
-        };
+        });
     </script>
 
 </body>
 </html>
 
 <!--
-MkDocs version : 1.4.2
-Build Date UTC : 2023-04-13 23:00:40.447031+00:00
+MkDocs version : 1.6.1
+Build Date UTC : 2024-09-25 19:10:14.341456+00:00
 -->
diff --git a/js/theme.js b/js/theme.js