◐ Shell
reader mode source ↗
Skip to content

Update python-docs-theme to work with Sphinx 5 & 6#99

Merged
JulienPalard merged 9 commits into
python:mainfrom
AA-Turner:sphinx-6
Apr 13, 2023
Merged

Update python-docs-theme to work with Sphinx 5 & 6#99
JulienPalard merged 9 commits into
python:mainfrom
AA-Turner:sphinx-6

Conversation

@AA-Turner

@AA-Turner AA-Turner commented Nov 11, 2022

Copy link
Copy Markdown
Member

Updated remaining jQuery scripts to standard JavaScript, and a few fixes for CSS changes.

A

@AA-Turner

AA-Turner commented Nov 11, 2022

Copy link
Copy Markdown
Member Author

Turns out this is required for Sphinx 5... python/cpython#99381

A

@AA-Turner AA-Turner changed the title Update for Sphinx 6 Nov 11, 2022
pradyunsg
pradyunsg approved these changes Nov 11, 2022
View reviewed changes

@pradyunsg pradyunsg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

LGTM

ezio-melotti
ezio-melotti reviewed Nov 12, 2022
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

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; or if (...) break; or even if (...) 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.

@hugovk

hugovk commented Feb 6, 2023

Copy link
Copy Markdown
Member

Is this ready to merge?

@hugovk

hugovk commented Feb 13, 2023

Copy link
Copy Markdown
Member

Rebased on main to build RTD preview:

And there's an error in the console:

sidebar.js:34 Uncaught TypeError: Cannot read properties of null (reading 'querySelector')
    at HTMLDocument.initialiseSidebar (sidebar.js:34:38)

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')

@m-aciek m-aciek mentioned this pull request Mar 13, 2023
Closed
@AA-Turner AA-Turner requested a review from hugovk April 11, 2023 15:51
@AA-Turner

AA-Turner commented Apr 11, 2023

Copy link
Copy Markdown
Member Author

Updated the JavaScript, the previous version was attempting to access an element that had yet to be created. Thank you for the review!

A

hugovk
hugovk approved these changes Apr 11, 2023
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Working fine now, thanks!

@AA-Turner AA-Turner requested review from JulienPalard and ezio-melotti and removed request for JulienPalard April 11, 2023 20:27
@AA-Turner AA-Turner changed the title Update for Sphinx 5 and 6 Apr 12, 2023
@JulienPalard JulienPalard merged commit 32115c4 into python:main Apr 13, 2023
@JulienPalard

JulienPalard commented Apr 13, 2023

Copy link
Copy Markdown
Member

I just built https://docs.python.org/3.12/ after merging this PR.

@AA-Turner

AA-Turner commented Apr 13, 2023

Copy link
Copy Markdown
Member Author

I just built 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 2023.4 release, to unblock python/cpython#99381?

A

@JulienPalard

JulienPalard commented Apr 17, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Releasing: #126

@AA-Turner AA-Turner mentioned this pull request Apr 20, 2023
Merged
@jurasofish jurasofish mentioned this pull request May 12, 2023
Closed
@AA-Turner AA-Turner deleted the sphinx-6 branch July 15, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

@pradyunsg pradyunsg pradyunsg approved these changes

@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti

@JulienPalard JulienPalard Awaiting requested review from JulienPalard

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@AA-Turner @hugovk @JulienPalard @pradyunsg @ezio-melotti