Pin sphinx !=6.1.3 (avoid non-functional Search utility on readthedocs) #3142
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
|
OK tests have completely vanished off the PR page - GH going through puberty again ffs 🤦♂️ |
valeriupredoi
changed the title
|
Thanks for looking into this @valeriupredoi! Did you report the issue with the rtd theme om their issue tracker? |
|
indeed I did @bouweandela - see here readthedocs/sphinx_rtd_theme#1451 - gotta get back to the dev who's replied to me last night tho |
|
am testing a different solution/workaround - so please don't review/merge this one just yet 👍 |
Merged
6 tasks
|
superseded with a more solid workaround by #3144 |
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.
Description
@ehogan and @remi-kazeroni have noticed that the Search utility on our documentation page became non functional at some point ie it kept doing nothing while it said "Searching..."
After a few trials in the environment it proves out that
sphinx_rtd_theme=1.2.0is not a big fan ofsphinx=6.1.3- the Search is a problem arising from having these two in the environment; there may be other problems that we don't know of.sphinx=5and anysphinx_rtd_theme(1.1.1 or 1.2.0) all give us a functional Search utility, so I pinnedsphinxto restrictive; mamba on RTD decides to grab 5.0 even though there are other newer versions; documentation builds well and is searchable https://esmvaltool--3142.org.readthedocs.build/en/3142/Before you get started
Checklist
It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.