Display example figures in a single column #21837
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
This overrides sphinx-gallery's CSS to make multiple images appear individually, which AFAICT looks better for all of our examples. It affects the following: - examples/axes_grid1/demo_axes_rgb.py - examples/color/colormap_reference.py - examples/color/named_colors.py - examples/event_handling/pick_event_demo.py - examples/event_handling/zoom_window.py - examples/images_contours_and_fields/barb_demo.py - examples/images_contours_and_fields/contourf_demo.py - examples/images_contours_and_fields/image_demo.py - examples/images_contours_and_fields/shading_example.py - examples/lines_bars_and_markers/fill_betweenx_demo.py - examples/specialty_plots/advanced_hillshading.py - examples/statistics/boxplot_demo.py - examples/style_sheets/style_sheets_reference.py - examples/text_labels_and_annotations/accented_text.py - examples/text_labels_and_annotations/annotation_demo.py - examples/ticks/tick-formatters.py - examples/userdemo/demo_gridspec03.py - tutorials/colors/colormaps.py - tutorials/colors/colors.py
Turning of multi-column display of figures in docs shows some examples that really should have been split apart. Most already have text that could go in the space between the figures, too.
|
For some reason the Artifact isn't found... |
|
Ah sorry, that's because I enabled Circle on my fork to test out the backport checks. Here's the direct link: https://80-21548241-gh.circle-artifacts.com/0/doc/build/html/index.html |
timhoffm
approved these changes
Dec 3, 2021
|
Can we backport this to 3.5-doc or does that not work because there are changes in the examples? |
|
Only stuff that changes installed files shouldn't be backported, so this is fine. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 4, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 4, 2021
QuLogic
added a commit
that referenced
this pull request
Dec 4, 2021
…837-on-v3.5.x Backport PR #21837 on branch v3.5.x (Display example figures in a single column)
QuLogic
added a commit
that referenced
this pull request
Dec 4, 2021
…837-on-v3.5.0-doc Backport PR #21837 on branch v3.5.0-doc (Display example figures in a single column)
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
This overrides the sphinx-gallery CSS when multiple figures are output, so that they appear as a single column (except if they are already narrow enough to fit together.) In a few cases, it is possible to split up examples so that figures are not stuck together anyway, so do that where possible.
This generally looks better to me, even if a few figures get bunched up.
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).