Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unbreak doc build with Sphinx 6.2 #25760

Merged
merged 1 commit into from Apr 24, 2023
Merged

unbreak doc build with Sphinx 6.2 #25760

merged 1 commit into from Apr 24, 2023

Conversation

rcomer
Copy link
Member

@rcomer rcomer commented Apr 24, 2023

PR Summary

Sphinx v6.2 was released yesterday, and the nitpick_ignore config 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

  • Added "closes #0000" in the PR description to link it to the original issue.

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@rcomer rcomer added the Documentation: build building the docs label Apr 24, 2023
@tacaswell tacaswell added this to the v3.7-doc milestone Apr 24, 2023
@tacaswell tacaswell requested a review from ksunden April 24, 2023 19:34
@ksunden
Copy link
Member

ksunden commented Apr 24, 2023

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.

@tacaswell
Copy link
Member

anyone can merge when CI is green.

@rcomer rcomer merged commit 52a2a7c into matplotlib:main Apr 24, 2023
20 checks passed
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
@rcomer rcomer deleted the new-sphinx branch April 24, 2023 19:54
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
Labels
Documentation: build building the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants