Remove dependency on jQuery #1546
Labels
Comments
ajkerrigan
added a commit
to ajkerrigan/cloud-custodian
that referenced
this issue
Aug 2, 2024
The Read the Docs theme for sphinx relies on jQuery in a few spots. It looks like we already have a sphinxcontrib-jquery but weren't referencing it as an extension in conf.py. Adding this seems more "workaround" than fix - it may be worth following the related upstream issue or monkeypatching our way around jQuery in c7n-sphinxext. See also: readthedocs/sphinx_rtd_theme#1546
ajkerrigan
added a commit
to ajkerrigan/cloud-custodian
that referenced
this issue
Aug 2, 2024
The Read the Docs theme for sphinx relies on jQuery in a few spots. It looks like we already have a sphinxcontrib-jquery dependency, but weren't referencing it as an extension in conf.py. Adding this seems more "workaround" than fix - it may be worth following the related upstream issue or monkeypatching our way around jQuery in c7n-sphinxext. See also: readthedocs/sphinx_rtd_theme#1546
ajkerrigan
added a commit
to cloud-custodian/cloud-custodian
that referenced
this issue
Aug 2, 2024
The Read the Docs theme for sphinx relies on jQuery in a few spots. It looks like we already have a sphinxcontrib-jquery dependency, but weren't referencing it as an extension in conf.py. Adding this seems more "workaround" than fix - it may be worth following the related upstream issue or monkeypatching our way around jQuery in c7n-sphinxext. See also: readthedocs/sphinx_rtd_theme#1546
|
We are depending on sphinxcontrib-jquery now, since this theme requires jQuery. Removing jQuery is not in our roadmap and we cannot prioritize it, but we would accept a PR for this. I think we can include it in the |
|
By the way, this is dup of #1253 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem
jQuery was removed from Sphinx in ~2022 with the release of Sphinx 6.0.0.
I came across this because of broken search functionality at https://pydicom.github.io/pydicom/dev/index.html. I realised the problem is that jQuery is somehow not loaded so
searchindex.jsisn't loaded. However, this simple need to load a script is trivial in vanilla JS nowadays, as Sphinx by default uses.If the maintainers don't want to remove jQuery for other downstream projects, at least we can start by porting some of the simply tasks to vanilla JS as Sphinx had done, so when jQuery breaks, it doesn't break the site.
The text was updated successfully, but these errors were encountered: