Attach sidebar-close handler to current-page links #1588
Conversation
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
This comment was marked as resolved.
This comment was marked as resolved.
This is intended primarily to resolve a problem with `singlehtml` documentation projects when viewed on narrow (typically mobile) displays. Under those circumstances, the `.current` CSS selector does not match any sidebar menu elements, because there is no logical notion of a 'current' page in `singlehtml` -- every item is on the same page. Therefore this change proposes an alternative way to identify sidebar links that are 'current' -- it checks for anchors that have an `href` beginning with the query-string fragment identifier (`#`). This is intended to be compatible with both `singlehtml` and `html` project builds. It depends upon sphinx-doc/sphinx#12551
jayaddison
force-pushed
the
issue-880/singlehtml-sidebar-css-selection
branch
from
2e97557 to
9d30f9e
Compare
|
Rebased against Test results when self-building the Before (buggy) buggy.mp4After (fixed) fixed.mp4 |
|
Note: based on the dependency deprecation history for the project, I'd anticipate that the very earliest that this could be merged would likely be for a 4.0 release. |
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.
This is intended primarily to resolve a problem with
singlehtmldocumentation projects when viewed on narrow (typically mobile) displays.Under those circumstances, the
.currentCSS selector does not match any sidebar menu elements, because there is no logical notion of a 'current' page insinglehtml-- every item is on the same page.Therefore this change proposes an alternative way to identify sidebar links that are 'current' -- it checks for anchors that have an
hrefbeginning with the query-string fragment identifier (#).This is intended to be compatible with both
singlehtmlandhtmlproject builds. It depends upon sphinx-doc/sphinx#12551Resolves #880.