-
Notifications
You must be signed in to change notification settings - Fork 11
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
Add explicit dependency to sphinx-rtd-theme (and through it, jQuery) #239
Conversation
This also pulls in jQuery
ac05d2f
to
fd99e45
Compare
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.
Thanks @rbberger for fixing this. I'll wait for @Yurlungur but I think this is a pretty straightforward change
Tagging @ktsai7 in case she has comments
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.
Thanks for the fix @rbberger !
We should add a changelog otherwise I approve. Merge when ready (after tests pass). |
just out of curiosity, since this is a fix, what was broken? |
@ktsai7 Newer versions of Sphinx and the rtd theme no longer include an embedded jQuery. Instead it now must be provided with the sphinxcontrib-jquery extension. rtd pulls that in for you, but for that you have to properly add it as extension to your config. Without jQuery, dynamic layout elements such as the version selection with multiversion fail due to missing JavaScript. |
I added the changelog and will merge when tests pass. |
PR Summary
Newer Sphinx and sphinx-rtd-theme do not include jQuery, which is a necessary feature for
sphinx_multiversion
to properly work. This adds thesphinx_rtd_theme
extension to our doc configuration, which also pulls insphinxcontrib-jquery
for us.See https://blog.readthedocs.com/sphinx6-upgrade/
PR Checklist
make format
command after configuring withcmake
.