Enable lazy-loading of images in HTML docs #25752
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
|
Thank you for this work. Looking at the built docs what should we be checking to tell if this had the intended affect or not? |
There was a problem hiding this comment.
This looks good to me. I think it is good to save bandwidth when we can.
In Chrome I was able to test with: "inspect" -> "Network" tab -> Change "No Throttling" to "Fast 3G". Then the simplest page to see this on for me was the "Examples" gallery. If you land on that page a few images will be loaded towards the top. Then wait a bit and scroll down quickly and a lot more will be loaded. Compare that to the devdocs page where all of the images are loaded right away. (Network tab will show you when the requests for new images were made as well along the timeline)
PR Summary
Leverage docutils to automatically set the
loadingattribute of images to"lazy"in the HTML docs. This should hopefully improve performance, especially on cellular or low-bandwidth connections.Closes #24331
PR Checklist
Linked Issue
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst