Merge pull request #841 from executablebooks/agoose77/fix-pydata-sphinx-theme-update

FIX: breaking style changes in pydata-sphinx-theme

Author: agoose77

.github/workflows/tests.yml

@@ -63,8 +63,9 @@ jobs:
         pytest --durations=10 --cov=sphinx_book_theme --cov-report=xml --cov-report=term-missing
 
     # Only upload to codecov on pull requests so that we don't trigger rate limit blocks
+    # Disabled for now with false &&
     - name: Upload to Codecov
-      if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9 && matrix.sphinx == '~=7.0' && github.repository == 'executablebooks/sphinx-book-theme' && github.event_name == 'pull_request'
+      if: false && matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9 && matrix.sphinx == '~=7.0' && github.repository == 'executablebooks/sphinx-book-theme' && github.event_name == 'pull_request'
       uses: codecov/[email protected]
       with:
         name: ebp-sbt-pytests-py3.7
@@ -111,7 +112,7 @@ jobs:
         text = Path("./warnings.txt").read_text().strip()
         expected_warning_patterns = [r"kitchen\-sink", r"urllib/parse\.py", r"Glyph 10024 .*? missing from current font"]
         print("\n=== Sphinx Warnings ===\n\n" + text)  # Print just for reference so we can look at the logs
-        unexpected = [l for l in text.splitlines() if not any(re.search(p, ii) for p in expected_warning_patterns)]
+        unexpected = [l for l in text.splitlines() if not any(re.search(p, l) for p in expected_warning_patterns)]
         assert len(unexpected) == 0, unexpected
 
     - name: Audit with Lighthouse

docs/conf.py

@@ -187,7 +187,7 @@
     "http://someurl/release",  # This is a fake link
     "https://doi.org",  # These don't resolve properly and cause SSL issues
 ]
-
+linkcheck_exclude_documents = ["changelog"]
 
 # -- Download latest theme elements page from PyData -----------------------------
 

docs/reference/special-theme-elements.md

@@ -301,8 +301,10 @@ An admonition with a sidenote defined in the admonition[^snam1] and another defi
 These aren't theme-specific, but we still show below to make sure they work.
 
 ::::{note} Here's a note!
-:::{tip} And a tip!
-:::
+
+```{tip} And a tip!
+```
+
 ::::
 
 ## MyST Markdown elements

pyproject.toml

@@ -81,11 +81,13 @@ doc = [
 test = [
     "beautifulsoup4",
     "coverage",
+    "defusedxml",
     "myst-nb",
     "pytest",
     "pytest-cov",
     "pytest-regressions",
     "sphinx_thebe",
+    "pydata-sphinx-theme>=0.15.2"
 ]
 
 [project.entry-points]

src/sphinx_book_theme/assets/styles/sections/_header-article.scss

@@ -15,7 +15,7 @@
  * Sidebar toggle over-rides for PST
  */
 // Primary toggle is always visible
-label.sidebar-toggle.primary-toggle {
+button.sidebar-toggle.primary-toggle {
   @media (min-width: $breakpoint-md) {
     display: inline-block;
   }
@@ -25,7 +25,7 @@ label.sidebar-toggle.primary-toggle {
 }
 
 // Secondary toggle mimics behavior of "persistent header" div of PST
-label.sidebar-toggle.secondary-toggle {
+button.sidebar-toggle.secondary-toggle {
   @media (min-width: $breakpoint-lg) {
     display: none;
   }

src/sphinx_book_theme/assets/styles/sections/_header-primary.scss

@@ -4,7 +4,7 @@
 
   // Turn these off because we'll show it in the article header
   // The primary sidebar toggle
-  label.sidebar-toggle {
+  button.sidebar-toggle {
     display: none;
   }
 }

src/sphinx_book_theme/assets/styles/sections/_sidebar-primary.scss

@@ -36,7 +36,9 @@
 // It is shown by default, and hidden with a click.
 // Mobile behavior is defined in the pydata sphinx theme
 @media (min-width: $breakpoint-lg) {
-  input#__primary:checked ~ .bd-container .bd-sidebar-primary {
+  input#pst-primary-sidebar-checkbox:checked
+    ~ .bd-container
+    .bd-sidebar-primary {
     margin-left: -$sidebar-primary-width-widescreen;
     visibility: hidden;
     opacity: 0;

src/sphinx_book_theme/theme/sphinx_book_theme/components/toggle-primary-sidebar.html

@@ -1,3 +1,3 @@
-<label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
+<button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
   <span class="fa-solid fa-bars"></span>
-</label>
+</button>

src/sphinx_book_theme/theme/sphinx_book_theme/components/toggle-secondary-sidebar.html

@@ -1,7 +1,7 @@
 {# The in-page Table of Contents -#}
 {% set page_toc = generate_toc_html() -%}
 {% if page_toc -%}
-<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
+<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <span class="fa-solid fa-list"></span>
-</label>
+</button>
 {%- endif %}

tests/test_build/build__header-article.html

@@ -1,11 +1,11 @@
-<div class="bd-header-article">
+<div class="bd-header-article d-print-none">
  <div class="header-article-items header-article__inner">
   <div class="header-article-items__start">
    <div class="header-article-item">
-    <label class="sidebar-toggle primary-toggle btn btn-sm" data-bs-placement="bottom" data-bs-toggle="tooltip" for="__primary" title="Toggle primary sidebar">
+    <button class="sidebar-toggle primary-toggle btn btn-sm" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Toggle primary sidebar">
      <span class="fa-solid fa-bars">
      </span>
-    </label>
+    </button>
    </div>
   </div>
   <div class="header-article-items__end">