-
-
Notifications
You must be signed in to change notification settings - Fork 60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update python-docs-theme
to work with Sphinx 5 & 6
#99
Conversation
Turns out this is required for Sphinx 5... python/cpython#99381 A |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In addition to the inline comments, I have two generic comments:
- The use of semicolons at the end of the line seems inconsistent. Unless there is a specific reason to keep them, I would just remove them all.
- I would avoid the use of
if (...) return;
orif (...) break;
or evenif (...) some_functions()
. The expression after the condition should go on a new line, and it should be surrounded by{ }
, e.g.:if (...) { ... }
Fun fact: I originally implemented both the collapsible sidebar (~12 years ago in python/cpython#47393) and the copybutton (~11 years ago in python/cpython@59dba38) and since then they have traveled around a number of dirs and repos. It's nice to see that in the meanwhile things got standardized and JS evolved to the point that JQuery is no longer needed.
Is this ready to merge? |
Rebased on And there's an error in the console:
From the last line of: const bodyWrapper = document.getElementsByClassName("bodywrapper")[0]
const sidebar = document.getElementsByClassName("sphinxsidebar")[0]
const sidebarWrapper = document.getElementsByClassName('sphinxsidebarwrapper')[0]
const sidebarButton = document.getElementById("sidebarbutton")
const sidebarArrow = sidebarButton.querySelector('span') |
Updated the JavaScript, the previous version was attempting to access an element that had yet to be created. Thank you for the review! A |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Working fine now, thanks!
python-docs-theme
to work with Sphinx 5 & 6
I just built https://docs.python.org/3.12/ after merging this PR. |
Working for me in Firefox 112 on Windows! If you have time over the next few weeks, please would we be able to make a A |
Releasing: #126 |
Updated remaining jQuery scripts to standard JavaScript, and a few fixes for CSS changes.
A