Search: correctly remove Search.init on Sphinx >= 5.0 #100
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
On sphinx-doc/sphinx#10028 the `Sphinx.init` call was changed to be called with the `_ready` function. We need to update our regex to catch that, otherwise `Sphinx.init` will be called twice. Closes readthedocs/readthedocs.org#8862.
stsewd
commented
Jan 31, 2022
| sphinxlatest: Sphinx | ||
| sphinxmaster: git+https://github.com/sphinx-doc/sphinx.git@master |
There was a problem hiding this comment.
I'm not running sphinxmaster on circle since it could fail, but it's useful for testing future changes locally.
stsewd
commented
Jan 31, 2022
tox.ini
Outdated
| @@ -1,7 +1,7 @@ | |||
| [tox] | |||
| envlist = | |||
| py{27,36}-sphinx{15,16,17,18} | |||
| py{36,37,38,39}-sphinx{21,22,23,24,30,31,32,33,34,latest} | |||
| py{36,37,38,39,310}-sphinx{21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,latest} | |||
There was a problem hiding this comment.
Looks like sphinx 3.5, 4.0 and 4.1 aren't compatible with python 3.10 (bc of changes on the typing module). Thoughts about testing 3.10 only for sphinx>=4.2?
humitos
approved these changes
Jan 31, 2022
Comment on lines
+252
to
258
| ^(\$\(document\).ready\(function\s*\(\)\s*{(?:\n|\r\n?) | ||
| \s*Search.init\(\);(?:\n|\r\n?) | ||
| \}\); | ||
| \}\);) | ||
| | | ||
| # Sphinx >=5.0 calls Search.init this way. | ||
| (_ready\(Search.init\);) | ||
| ''', |
There was a problem hiding this comment.
I think it would be good to add links to the sphinx code we are expecting to search & replace as comments in this regex for easier tracking/understanding of it.
There was a problem hiding this comment.
@stsewd it seems you missed this comment.
There was a problem hiding this comment.
I updated the docstring ad92c76
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.
On sphinx-doc/sphinx#10028
the
Sphinx.initcall was changed to be called with the_readyfunction.
We need to update our regex to catch that,
otherwise
Sphinx.initwill be called twice.Also, I have updated our test matrix to include new versions of sphinx/python.
And in the latest version,
languagecan't beNone, so I'm changing it to 'en'.Closes readthedocs/readthedocs.org#8862.