Fix warning about 4-column-based-index #7
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
Stops the message `WARNING: 4 column based index found. It might be a bug of extensions you use:` appearing, which is due to sphinx changing from 4- to 5-column indices. This change will break compatibility with sphinx < 1.4.
cmarqu
reviewed
Dec 4, 2019
| @@ -76,7 +76,7 @@ def add_target_and_index(self, name, sig, signode): | |||
| indextype = 'single' | |||
| indexentry = self.indextemplate % (name,) | |||
| self.indexnode['entries'].append((indextype, indexentry, | |||
There was a problem hiding this comment.
Should we add if version_info < (1, 4): here to also support old Sphinx version? (This also needs import of version_info, see e.g. VACUMM/sphinx-fortran@f723ef2)
There was a problem hiding this comment.
I don't have an opinion about this. Either supporting and not supporting is okay for me.
If we choose to raise the target version of Sphinx, we have to update dependencies on setup.py.
@eric-wieser Could you check this please?
This was referenced Dec 3, 2020
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.
Stops the message
WARNING: 4 column based index found. It might be a bug of extensions you use:appearing, which is due to sphinx changing from 4- to 5-column indices.This change will break compatibility with sphinx < 1.4.
Note that this is only a warning, so doesn't really block anything - filing this primarily for a destination for google searches of that warning.