unbreak doc build with Sphinx 6.2 #25760
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
|
Cross ref sphinx-doc/sphinx#11355 (I had started working on a solution similar to this, but you got the PR in as I was running the doc build locally) If this were an extension we provided for downstream use, I may suggest maintaining the input type (if only to ensure compatibility with their own extensions which could rely on a particular data structure in much the same way) but since this is really only for internal use, no need to over complicate. |
ksunden
approved these changes
Apr 24, 2023
tacaswell
approved these changes
Apr 24, 2023
|
anyone can merge when CI is green. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 24, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 24, 2023
ksunden
added a commit
that referenced
this pull request
Apr 24, 2023
…760-on-v3.7.1-doc Backport PR #25760 on branch v3.7.1-doc (unbreak doc build with Sphinx 6.2)
tacaswell
added a commit
that referenced
this pull request
Apr 24, 2023
…760-on-v3.7.x Backport PR #25760 on branch v3.7.x (unbreak doc build with Sphinx 6.2)
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.
PR Summary
Sphinx v6.2 was released yesterday, and the
nitpick_ignoreconfig variable may now be a set, tuple or list, but defaults to set. This broke our extension, which assumes the variable is a list (as it was previously). See e.g. the most recent commit on main for example failure.I have also failed to get anything newer than Sphinx v5.3 in environments created from our conda yml, so a solution that also works for older versions is desirable.
PR Checklist
Linked Issue
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst