Make search compatible with sphinx 2.2.1 #6804
Merged
Conversation
This file contains hidden or 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
We are relying on FILE_SUFFIX, but we were relying on a bug actually sphinx-doc/sphinx#6741 This is compatible with older and new versions. This is also related that we don't save the real full path when indexing. https://github.com/readthedocs/readthedocs.org/blob/24ca737e3f5c0df359801a8dede6519f67a70cb6/readthedocs/search/api.py#L34-L38 Fixes #6801
ericholscher
approved these changes
Mar 26, 2020
humitos
reviewed
Mar 26, 2020
| var suffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; | ||
| // Since sphinx 2.2.1 FILE_SUFFIX is .html for all builders, | ||
| // and there is a new BUILDER option. | ||
| if ('BUILDER' in DOCUMENTATION_OPTIONS && DOCUMENTATION_OPTIONS.BUILDER === 'readthedocsdirhtml') { |
There was a problem hiding this comment.
Isn't it better to use .endswith('dirhtml') here? That way, we allow people using a different builder. See https://docs.readthedocs.io/en/stable/builds.html#writing-your-own-builder
There was a problem hiding this comment.
That case will be only valid for a custom installation with their own builders, not sure if users have that level of customization (there are a lot of parts to change the code to make that work)
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.
We are relying on FILE_SUFFIX,
but we were relying on a bug actually sphinx-doc/sphinx#6741
This is compatible with older and new versions.
This is also related that we don't save the real full path when
indexing.
readthedocs.org/readthedocs/search/api.py
Lines 34 to 38 in 24ca737
Fixes #6801