DOC: Add cache busting to all static assets #23790
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
We have seen both in `/stable` and `/3.6.0`, some styling is broken because old CSS is cached. CSS might change from updating sphinx-gallery, mpl-sphinx-theme, pydata-sphinx-theme, etc. Adding a versioned query breaks the cache. It's a bit over-eager to base it on Matplotlib version and not the file contents (since those dependencies may not have updated), but this should work well enough.
tacaswell
approved these changes
Aug 31, 2022
greglucas
approved these changes
Sep 1, 2022
doc/conf.py
Outdated
| # Sphinx setup | ||
| # ----------------------------------------------------------------------------- | ||
| def setup(app): | ||
| if any(st in version for st in ('post', 'alpha', 'beta')): |
There was a problem hiding this comment.
I think "post" would still be considered release?
There was a problem hiding this comment.
That's a good question, but I just moved this code to the bottom of the file. It looks like that's how it was when it came in, 310b004 so maybe @tacaswell knows why
There was a problem hiding this comment.
I think we used to use .postN to count the number of commits past the last tag, but we switch to using. .dev for the number of commits on a pre-release of our expected next tag...but I think that means we need to add 'dev' to this list as well?
tacaswell
reviewed
Sep 1, 2022
Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
|
@QuLogic can self-merge when CI is green. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 2, 2022
QuLogic
added a commit
that referenced
this pull request
Sep 2, 2022
…790-on-v3.6.x Backport PR #23790 on branch v3.6.x (DOC: Add cache busting to all static assets)
QuLogic
added a commit
to QuLogic/mpl-brochure-site
that referenced
this pull request
Sep 21, 2022
This is a copy of matplotlib/matplotlib#23790.
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
We have seen both in
/stableand/3.6.0(e.g., #23760), some styling is broken because old CSS is cached. CSS might change from updating sphinx-gallery, mpl-sphinx-theme, pydata-sphinx-theme, etc. Adding a versioned query breaks the cache.It's a bit over-eager to base it on Matplotlib version and not the file contents (since those dependencies may not have updated), but this should work well enough.
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).