Skip to content

Fix warning about 4-column-based-index#7

Open
eric-wieser wants to merge 1 commit into
sphinx-contrib:masterfrom
eric-wieser:patch-3
Open

Fix warning about 4-column-based-index#7
eric-wieser wants to merge 1 commit into
sphinx-contrib:masterfrom
eric-wieser:patch-3

Conversation

@eric-wieser

@eric-wieser eric-wieser commented Nov 19, 2019

Copy link
Copy Markdown
Contributor

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.

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.
@@ -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,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants