fix(docs): repair mobile sidebar by bumping sphinx-book-theme to 1.2.0#779
Open
FBumann wants to merge 1 commit into
Open
fix(docs): repair mobile sidebar by bumping sphinx-book-theme to 1.2.0#779FBumann wants to merge 1 commit into
FBumann wants to merge 1 commit into
Conversation
The docs pinned sphinx_book_theme==1.1.3, which has no upper bound on pydata-sphinx-theme and therefore resolved to pydata 0.16.1. The 1.1.x book theme predates pydata 0.16 and its mobile sidebar toggle JS breaks against it, so the navigation sidebar and ToC no longer open on mobile. Bump to sphinx_book_theme==1.2.0, the first release that pins and supports pydata-sphinx-theme==0.16.1, restoring the mobile toggles. Closes #775 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
FBumann
force-pushed
the
fix/docs-mobile-sidebar
branch
from
d8a2ad8 to
948075e
Compare
Collaborator
Author
|
confirmed on my phone on https://linopy--779.org.readthedocs.build/en/779/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #775 — the docs sidebar/ToC don't open on mobile.
Note
The following content was generated by AI.
Bump
sphinx_book_themefrom1.1.3to1.2.0in thedocsextra. The 1.1.x theme had no upper bound onpydata-sphinx-theme, so it pulled in0.16.1, whose DOM breaks the 1.1.x mobile sidebar/ToC toggle JS.1.2.0pins and supportspydata-sphinx-theme==0.16.1, restoring the toggles.Cause, compatibility check and verification
Cause —
pyproject.tomlpinssphinx_book_theme==1.1.3, which declarespydata-sphinx-theme>=0.15.2with no upper bound, so pip resolves topydata-sphinx-theme==0.16.1. The 1.1.x book theme predates pydata 0.16 and its mobile toggle JavaScript breaks against the 0.16 DOM.Upstream confirms the mismatch:
sphinx-book-theme==1.1.4hard-pinspydata-sphinx-theme==0.15.4, and1.2.0is the first release to pin and supportpydata-sphinx-theme==0.16.1.Compatibility —
1.2.0requiressphinx>=7.0(we use7.3.7) and Python>=3.11(RTD builds on 3.12), so no other changes are needed.Verification — docs build cleanly with the new theme (
sphinx-build -b html, no errors).