Remove html_theme_path setting from docs config to fix search & other JavaScript functions
#970
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently search and other JavaScript functions fail on the RTD documentation page, due to an exception thrown over missing jQuery. Searching upstream, this can be caused by setting `html_theme_path` which was previously recommended but is now out of date. This updates the config in-line with current advice from sphinx_rtd_theme adding it to `extensions` and removing the `html_theme_path` setting.
github-actions
bot
added
the
Documentation
Vinc0110
approved these changes
Nov 2, 2023
jhillairet
approved these changes
Nov 3, 2023
|
Thanks a lot ! |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've noticed that search and other JavaScript functions (like opening the version information box in the bottom left) fail on the readthedocs page, which I think is due to an exception thrown over missing jQuery.
I found some advice in the sphinx_rtd_theme issues (1, 2) suggesting this can be caused by setting
html_theme_path, which was previously recommended but is now out of date.This updates the config in-line with current advice from sphinx_rtd_theme adding it to
extensionsand removing thehtml_theme_pathsetting.I wasn't able to reproduce the problem offline to test, but I'm hoping this PR kicks off an RTD build to test it outEdit: the build worked, and it seems to be fixed! https://scikit-rf--970.org.readthedocs.build/en/970/