Don't duplicate the sidebar button on Sphinx 5 and newer - #127
Merged
hugovk merged 3 commits intoApr 25, 2023
Merged
hugovk merged 3 commits into
hugovk merged 3 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Merged
AA-Turner
commented
Apr 20, 2023
Comment thread
python_docs_theme/static/sidebar.js_t
Outdated
Copy link
Copy Markdown
Member
Author
|
I've updated python/cpython#99381 to point to this PR, so that it installs Sphinx 6.1.3 and python-docs-theme as of this PR. The deploy preview seems to show that all is working as intended on newer Sphinx versions, and this PR's RTD preview shows it working on older Sphinx versions. A |
Sorry, something went wrong.
pradyunsg
approved these changes
Apr 21, 2023
hugovk
approved these changes
Apr 21, 2023
Copy link
Copy Markdown
Member
Author
|
Thanks Hugo! A |
Sorry, something went wrong.
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
Reviewers
Assignees
3 participants
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.
The sidebar button is included in the generated HTML from Sphinx 5 onwards (specifically, from sphinx-doc/sphinx@3b01fbe and the changes to themes/classic/layout.html).
We use the sphinx_version_tuple templating variable addded in Sphinx 4.2 to determine if we should add the sidebar button dynamically via JavaScript, or load the pre-existing button element from HTML.
I have tested locally on Sphinx 6.1.3, Sphinx 3.2.0, and Sphinx 4.5.0--all three display correct behaviour with respect to the sidebar.
A