deploy: 8b04498

buvis · Sep 23, 2024 · 010fb68 · 010fb68
1 parent 998efca
commit 010fb68
Show file tree

Hide file tree

Showing 6 changed files with 145 additions and 48 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/_static/css/theme.css b/_static/css/theme.css
diff --git a/_static/js/versions.js b/_static/js/versions.js
@@ -1,21 +1,29 @@
-function renderLanguages(config) {
-   if (!config.projects.translations.length) {
-     return "";
-   }
-
-   const languagesHTML = `
-     <dl>
-       <dt>Languages</dt>
-       ${ config.projects.translations.map(
-       (translation) => `
-       <dd ${ translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : '' }>
-         <a href="${ translation.urls.documentation }">${ translation.language.code }</a>
-       </dd>
-       `).join("\n")}
-     </dl>
-   `;
-   return languagesHTML;
- }
+const themeFlyoutDisplay = "hidden";
+const themeVersionSelector = "True";
+const themeLanguageSelector = "True";
+
+if (themeFlyoutDisplay === "attached") {
+  function renderLanguages(config) {
+    if (!config.projects.translations.length) {
+      return "";
+    }
+
+    const languagesHTML = `
+      <dl>
+        <dt>Languages</dt>
+        ${config.projects.translations
+          .map(
+            (translation) => `
+        <dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>
+          <a href="${translation.urls.documentation}">${translation.language.code}</a>
+        </dd>
+        `,
+          )
+          .join("\n")}
+      </dl>
+    `;
+    return languagesHTML;
+  }
 
   function renderVersions(config) {
     if (!config.versions.active.length) {
@@ -24,12 +32,15 @@ function renderLanguages(config) {
     const versionsHTML = `
       <dl>
         <dt>Versions</dt>
-        ${ config.versions.active.map(
-        (version) => `
-        <dd ${ version.slug === config.versions.current.slug ? 'class="rtd-current-item"' : '' }>
-          <a href="${ version.urls.documentation }">${ version.slug }</a>
+        ${config.versions.active
+          .map(
+            (version) => `
+        <dd ${version.slug === config.versions.current.slug ? 'class="rtd-current-item"' : ""}>
+          <a href="${version.urls.documentation}">${version.slug}</a>
         </dd>
-        `).join("\n")}
+        `,
+          )
+          .join("\n")}
       </dl>
     `;
     return versionsHTML;
@@ -48,42 +59,45 @@ function renderLanguages(config) {
     const downloadsHTML = `
       <dl>
         <dt>Downloads</dt>
-        ${ Object.entries(config.versions.current.downloads).map(
-        ([name, url]) => `
+        ${Object.entries(config.versions.current.downloads)
+          .map(
+            ([name, url]) => `
           <dd>
-            <a href="${ url }">${ downloadsNameDisplay[name] }</a>
+            <a href="${url}">${downloadsNameDisplay[name]}</a>
           </dd>
-        `).join("\n")}
+        `,
+          )
+          .join("\n")}
       </dl>
     `;
     return downloadsHTML;
   }
 
-  document.addEventListener("readthedocs-addons-data-ready", function(event) {
+  document.addEventListener("readthedocs-addons-data-ready", function (event) {
     const config = event.detail.data();
 
     const flyout = `
       <div class="rst-versions" data-toggle="rst-versions" role="note">
         <span class="rst-current-version" data-toggle="rst-current-version">
           <span class="fa fa-book"> Read the Docs</span>
-          v: ${ config.versions.current.slug }
+          v: ${config.versions.current.slug}
           <span class="fa fa-caret-down"></span>
         </span>
         <div class="rst-other-versions">
           <div class="injected">
-            ${ renderLanguages(config) }
-            ${ renderVersions(config) }
-            ${ renderDownloads(config) }
+            ${renderLanguages(config)}
+            ${renderVersions(config)}
+            ${renderDownloads(config)}
             <dl>
               <dt>On Read the Docs</dt>
               <dd>
-                <a href="${ config.projects.current.urls.home }">Project Home</a>
+                <a href="${config.projects.current.urls.home}">Project Home</a>
               </dd>
               <dd>
-                <a href="${ config.projects.current.urls.builds }">Builds</a>
+                <a href="${config.projects.current.urls.builds}">Builds</a>
               </dd>
               <dd>
-                <a href="${ config.projects.current.urls.downloads }">Downloads</a>
+                <a href="${config.projects.current.urls.downloads}">Downloads</a>
               </dd>
             </dl>
             <dl>
@@ -112,14 +126,97 @@ function renderLanguages(config) {
     document.body.insertAdjacentHTML("beforeend", flyout);
 
     // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout.
-    document.querySelector("#flyout-search-form").addEventListener("focusin", () => {
-      const event = new CustomEvent("readthedocs-search-show");
-      document.dispatchEvent(event);
-    });
+    document
+      .querySelector("#flyout-search-form")
+      .addEventListener("focusin", () => {
+        const event = new CustomEvent("readthedocs-search-show");
+        document.dispatchEvent(event);
+      });
 
     // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
-    document.querySelector("[role='search'] input").addEventListener("focusin", () => {
-      const event = new CustomEvent("readthedocs-search-show");
-      document.dispatchEvent(event);
-    });
- });
+    document
+      .querySelector("[role='search'] input")
+      .addEventListener("focusin", () => {
+        const event = new CustomEvent("readthedocs-search-show");
+        document.dispatchEvent(event);
+      });
+  });
+}
+
+if (themeLanguageSelector || themeVersionSelector) {
+  function onSelectorSwitch(event) {
+    const option = event.target.selectedIndex;
+    const item = event.target.options[option];
+    window.location.href = item.dataset.url;
+  }
+
+  document.addEventListener("readthedocs-addons-data-ready", function (event) {
+    const config = event.detail.data();
+
+    const versionSwitch = document.querySelector(
+      "div.switch-menus > div.version-switch",
+    );
+    if (themeVersionSelector) {
+      let versions = config.versions.active;
+      if (config.versions.current.type === "external") {
+        versions.unshift(config.versions.current);
+      }
+      const versionSelect = `
+    <select>
+      ${versions
+        .map(
+          (version) => `
+        <option
+  value="${version.slug}"
+  ${config.versions.current.slug === version.slug ? 'selected="selected"' : ""}
+              data-url="${version.urls.documentation}">
+              ${version.slug}
+          </option>`,
+        )
+        .join("\n")}
+    </select>
+  `;
+
+      versionSwitch.innerHTML = versionSelect;
+      versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+    }
+
+    const languageSwitch = document.querySelector(
+      "div.switch-menus > div.language-switch",
+    );
+
+    if (themeLanguageSelector) {
+      if (config.projects.translations.length) {
+        // Add the current language to the options on the selector
+        let languages = config.projects.translations.concat(
+          config.projects.current,
+        );
+        languages = languages.sort((a, b) =>
+          a.language.name.localeCompare(b.language.name),
+        );
+
+        const languageSelect = `
+      <select>
+        ${languages
+          .map(
+            (language) => `
+              <option
+                  value="${language.language.code}"
+                  ${config.projects.current.slug === language.slug ? 'selected="selected"' : ""}
+                  data-url="${language.urls.documentation}">
+                  ${language.language.name}
+              </option>`,
+          )
+          .join("\n")}
+       </select>
+    `;
+
+        languageSwitch.innerHTML = languageSelect;
+        languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+      }
+      else {
+        languageSwitch.remove();
+      }
+    }
+  });
+}
diff --git a/genindex.html b/genindex.html
@@ -7,7 +7,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Index &mdash; BUVIS Scripts  documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
-      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=66b59bf7" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>

diff --git a/index.html b/index.html
@@ -8,7 +8,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Bob’s Universal and Very Intelligent System scripts documentation &mdash; BUVIS Scripts  documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
-      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=66b59bf7" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>

diff --git a/search.html b/search.html
@@ -7,7 +7,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Search &mdash; BUVIS Scripts  documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
-      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=66b59bf7" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />