Skip to content

Small improvements to interactive examples #21835

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

Merged
merged 3 commits into from
Dec 16, 2021

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Dec 2, 2021

PR Summary

Adds a note about lack of interactivity in static docs, and tweaks some examples to look better once the multi-column sphinx-gallery CSS is removed.

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

In the docs, all the figures show up scrunched at the end after a large
block of code. But each figure is self-contained and already contains
some documentation, so split them up based on that.
This is a small tweak to make it fit in one line when the CSS to drop
the max-width is added.
@timhoffm timhoffm added this to the v3.5.2 milestone Dec 16, 2021
@timhoffm timhoffm merged commit 0ae666b into matplotlib:main Dec 16, 2021
@lumberbot-app
Copy link

lumberbot-app bot commented Dec 16, 2021

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -m1 0ae666bebcded3dfe82878499382dc4c72d47d36
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #21835: Small improvements to interactive examples'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-21835-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #21835 on branch v3.5.x (Small improvements to interactive examples)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@timhoffm
Copy link
Member

Remilestoned to 3.6, because I'm not going to bother with a manual backport for this.

@QuLogic QuLogic deleted the interactive-docs branch December 16, 2021 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants