Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Drop Sphinx compatibility to < 6 #1282

Closed
agjohnson opened this issue Feb 2, 2022 · 3 comments · Fixed by #1332
Closed

Drop Sphinx compatibility to < 6 #1282

agjohnson opened this issue Feb 2, 2022 · 3 comments · Fixed by #1332
Assignees
@benjaoming
Labels
Improvement Minor improvement to code
Milestone
1.1

Comments

@agjohnson
Copy link
Collaborator

agjohnson commented Feb 2, 2022 •
edited by benjaoming

Sphinx 5.0 Sphinx 6 is dropping jQuery support, which we have historically piggybacked off of. Removing jQuery support here (and in RTD) is totally valid and a good goal as well, we're not doing anything with jQuery that we couldn't do by hand. But to start, we should squeak out a release that pins our Sphinx < 5 so we don't risk a theme version that doesn't have jQuery underneath.

We can discuss a few options for removing jQuery, including porting code and async loading of jQuery when it doesn't exist through webpack (we use this feature in our new site templates).

Related #1253
@agjohnson agjohnson added the Improvement Minor improvement to code label Feb 2, 2022
@agjohnson agjohnson modified the milestones: 1.0, 1.1 Feb 2, 2022
@astrojuanlu
Copy link
Contributor

But to start, we should squeak out a release that pins our Sphinx < 5 so we don't risk a theme version that doesn't have jQuery underneath.

Indeed!

@felixoi
Copy link

felixoi commented Jun 5, 2022 •
edited

As Sphinx 5.0 is released, do I read this correct that currently rtd_theme is not compatible with it?

EDIT: As per changelog the removal happens ongoing from 6.0, correct?

jQuery and underscore.js will no longer be automatically injected into themes from Sphinx 6.0.

@stsewd
Copy link
Member

stsewd commented Jun 6, 2022

EDIT: As per changelog the removal happens ongoing from 6.0, correct?

yes, 6.0 will drop jquery, not 5.x

@benjaoming benjaoming changed the title Drop Sphinx compatibility to < 5 Drop Sphinx compatibility to < 6 Aug 12, 2022
@benjaoming benjaoming mentioned this issue Aug 24, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@benjaoming benjaoming

Labels
Improvement Minor improvement to code
Projects
📍Roadmap
Archived in project
Milestone
1.1
Development

Successfully merging a pull request may close this issue.

Add an upper bound for when Sphinx 6 is released benjaoming/sphinx_rtd_theme
5 participants
@astrojuanlu @benjaoming @agjohnson @stsewd @felixoi