DOC: Fix examples gallery layout issues #24475

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

Jump to bottom

Merged

tacaswell merged 1 commit into matplotlib:main from StefRe:patch-1

Nov 16, 2022

Merged

DOC: Fix examples gallery layout issues #24475

tacaswell merged 1 commit into matplotlib:main from StefRe:patch-1

Nov 16, 2022

Conversation

StefRe

Copy link

Contributor

@StefRe StefRe commented Nov 16, 2022

PR Summary

Fix single column layout and extra white space caused by pydata-sphinx-theme 0.10.0, see #23976. This was fixed in pydata/pydata-sphinx-theme/pull/964.

Closes #23976.

PR Checklist

Documentation and Tests

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

Release Notes

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

@StefRe


 DOC: Fix examples gallery layout issues

ee6f0f4

Fix single column layout and extra white space caused by
pydata-sphinx-theme 0.10.0, see matplotlib#23976. This was fixed
in github.com/pydata/pydata-sphinx-theme/pull/964.

@story645 story645 added Documentation: build PR: dependencies labels

Nov 16, 2022

ksunden

ksunden approved these changes

Nov 16, 2022

View reviewed changes

@jklymak

Copy link

Member

jklymak commented Nov 16, 2022

Should we be pinning in mpl-sphinx-theme instead?

@tacaswell tacaswell added this to the v3.6-doc milestone

Nov 16, 2022

@tacaswell

Copy link

Member

tacaswell commented Nov 16, 2022

Merging this is the pragmatic fix so lets merge it to unbreak the docs.

This also seems to have effectively resolved itself as the latest run of the dev-docs grabbed 0.11.0 or better anyway.

In mpl-sphinx-theme we have an unreleased commit that pins to pydata-sphinx-theme to >=0.11.0 and I think pinning it forward is a different issue.

I am wary of pinning to tightly to the libraries in the docs requirement stack. If I am reading this correctly this is due to change in sphinx-gallery than required a change in pydata-sphinx-theme? I think our options here are to push pins forward is a bunch of places or to very aggressively exactly pin. I would much rather pin forward and deal with transient issue like this than get in to the business of lots of exact pinning.