docs(fix[spa-nav]): SPA navigation scroll to hash anchors [DO NOT MERGE yet]#680
Closed
tony wants to merge 3 commits into
Closed
docs(fix[spa-nav]): SPA navigation scroll to hash anchors [DO NOT MERGE yet]#680tony wants to merge 3 commits into
tony wants to merge 3 commits into
Conversation
…ion-scroll branch why: Pick up layout.js fix that adds gp-sphinx:navigated listener for SPA hash-anchor expansion (git-pull/gp-sphinx#44). what: - Add [tool.uv.sources] override pointing sphinx-ux-autodoc-layout to the spa-navigation-scroll branch of gp-sphinx - Update uv.lock
why: The local docs/_static/js/spa-nav.js shadowed the theme's corrected version. It used document.querySelector(hash) which fails silently on Python API IDs containing dots (CSS interprets dots as class selectors). The theme's version uses getElementById(). what: - Remove docs/_static/js/spa-nav.js (254 lines) - Sphinx will now resolve js/spa-nav.js from sphinx-gp-theme's bundled static files
why: Test SPA navigation scroll fix on the live docs site. what: - Add spa-navigation-scroll to docs workflow branch trigger - Must be reverted before merge
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #680 +/- ##
=======================================
Coverage 51.37% 51.37%
=======================================
Files 25 25
Lines 3488 3488
Branches 686 686
=======================================
Hits 1792 1792
Misses 1401 1401
Partials 295 295 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
Author
|
Superseded — gp-sphinx 0.0.1a21 ships the expandForHash fix, and the bundled spa-nav.js has been removed from master. |
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.
Summary
docs/_static/js/spa-nav.jsthat shadowed the theme's corrected version — it useddocument.querySelector(hash)which silently fails on Python API IDs containing dots (CSS interprets them as class selectors)sphinx-ux-autodoc-layouttogp-sphinxbranchspa-navigation-scroll(layout(fix[expandForHash]): listen for gp-sphinx:navigated on SPA navigation git-pull/gp-sphinx#44) to pick up thelayout.jsfix that adds agp-sphinx:navigatedlistener for SPA hash-anchor expansionTest plan
uv.sourcesoverride once gp-sphinx releases