FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Makefile html-noplot,clean: constrained layout tutorial image handling by rcomer · Pull Request #24445 · matplotlib/matplotlib · GitHub

Repository navigation

Makefile html-noplot,clean: constrained layout tutorial image handling - #24445

Merged
tacaswell merged 1 commit into
matplotlib:mainfrom
rcomer:noplot-warning
Feb 1, 2023
Merged

tacaswell merged 1 commit into
matplotlib:mainfrom
rcomer:noplot-warning

Conversation

rcomer commented Nov 13, 2022

Copy link
Copy Markdown
Member

PR Summary

Follow up to #23870. It seems I somehow missed a couple of warnings that are thrown when running make html-noplot. Perhaps my branch was not fully up-to-date.

/home/ruth/git_stuff/matplotlib/doc/tutorials/intermediate/constrainedlayout_guide.rst:: WARNING: image file not readable: _static/constrained_layout_1b.png
/home/ruth/git_stuff/matplotlib/doc/tutorials/intermediate/constrainedlayout_guide.rst:: WARNING: image file not readable: _static/constrained_layout_2b.png

My current change is very specific to the constrained layout tutorial, but it looks like the image handling in the constrained layout tutorial is very specific to issues encountered there: #22289 (comment), sphinx-gallery/sphinx-gallery#726.

PR Checklist

Tests and Styling

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

Documentation

  • 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 commented Nov 13, 2022

Copy link
Copy Markdown
Member Author

Updated so that these images get tidied by make clean. Perhaps my previous reliance on make clean is why I didn't see these warnings last time.

rcomer changed the title html-noplot: filter warnings for constrained layout tutorial images Makefile html-noplot,clean: constrained layout tutorial image handling Nov 13, 2022

jklymak commented Nov 14, 2022

Copy link
Copy Markdown
Member

Constrained layout needs to show the difference between bbox_inches='tight' and not calling that, so it saves the image and then links it. We could just commit the image, but if things change, someone would have to remember to regenerate it. This seemed easiest. Alternates five years ago were non-trivial: sphinx-gallery/sphinx-gallery#726

tacaswell added this to the v3.8.0 milestone Feb 1, 2023
tacaswell merged commit faf88bf into matplotlib:main Feb 1, 2023
rcomer deleted the noplot-warning branch February 2, 2023 19:40
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL