fix: pin pydata-sphinx-theme tests

executablebooks · Oct 30, 2024 · 834ac48 · 834ac48
1 parent d46f705
commit 834ac48
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 81 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -87,6 +87,9 @@ test = [
     "pytest-cov",
     "pytest-regressions",
     "sphinx_thebe",
+    # Our regression testing is sensitive to DOM changes
+    # So, pin pydata-sphinx-theme
+    "pydata-sphinx-theme~=0.16.0"
 ]
 
 [project.entry-points]

diff --git a/tests/test_build/build__header-article.html b/tests/test_build/build__header-article.html
@@ -106,22 +106,18 @@
        </i>
       </span>
      </button>
-     <script>
-      document.write(`
-  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
-  </button>
-`);
-     </script>
-     <script>
-      document.write(`
-  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
-  </button>
-`);
-     </script>
+     <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
+      <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
+      </i>
+      <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
+      </i>
+      <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
+      </i>
+     </button>
+     <button aria-label="Search" class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search">
+      <i class="fa-solid fa-magnifying-glass fa-lg">
+      </i>
+     </button>
     </div>
    </div>
   </div>

diff --git a/tests/test_build/build__pagetoc--page-multipletitles.html b/tests/test_build/build__pagetoc--page-multipletitles.html
@@ -1,4 +1,4 @@
-<div class="bd-sidebar-secondary bd-toc">
+<div class="bd-sidebar-secondary bd-toc" id="pst-secondary-sidebar">
  <div class="sidebar-secondary-items sidebar-secondary__inner">
   <div class="sidebar-secondary-item">
    <div class="page-toc tocsection onthispage">

diff --git a/tests/test_build/header__repo-buttons--all-off.html b/tests/test_build/header__repo-buttons--all-off.html
@@ -37,22 +37,18 @@
      </i>
     </span>
    </button>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
-  </button>
-`);
-   </script>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
-  </button>
-`);
-   </script>
+   <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
+    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
+    </i>
+    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
+    </i>
+    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
+    </i>
+   </button>
+   <button aria-label="Search" class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search">
+    <i class="fa-solid fa-magnifying-glass fa-lg">
+    </i>
+   </button>
   </div>
  </div>
 </div>
diff --git a/tests/test_build/header__repo-buttons--all-on.html b/tests/test_build/header__repo-buttons--all-on.html
@@ -78,22 +78,18 @@
      </i>
     </span>
    </button>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
-  </button>
-`);
-   </script>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
-  </button>
-`);
-   </script>
+   <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
+    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
+    </i>
+    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
+    </i>
+    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
+    </i>
+   </button>
+   <button aria-label="Search" class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search">
+    <i class="fa-solid fa-magnifying-glass fa-lg">
+    </i>
+   </button>
   </div>
  </div>
 </div>
diff --git a/tests/test_build/header__repo-buttons--custom-branch.html b/tests/test_build/header__repo-buttons--custom-branch.html
@@ -61,22 +61,18 @@
      </i>
     </span>
    </button>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
-  </button>
-`);
-   </script>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
-  </button>
-`);
-   </script>
+   <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
+    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
+    </i>
+    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
+    </i>
+    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
+    </i>
+   </button>
+   <button aria-label="Search" class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search">
+    <i class="fa-solid fa-magnifying-glass fa-lg">
+    </i>
+   </button>
   </div>
  </div>
 </div>
diff --git a/tests/test_build/header__repo-buttons--one-on.html b/tests/test_build/header__repo-buttons--one-on.html
@@ -43,22 +43,18 @@
      </i>
     </span>
    </button>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
-    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
-  </button>
-`);
-   </script>
-   <script>
-    document.write(`
-  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
-  </button>
-`);
-   </script>
+   <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
+    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
+    </i>
+    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
+    </i>
+    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
+    </i>
+   </button>
+   <button aria-label="Search" class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search">
+    <i class="fa-solid fa-magnifying-glass fa-lg">
+    </i>
+   </button>
   </div>
  </div>
 </div>