Skip to content
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

Disable add_html_cache_busting on Sphinx 7.1+ #26493

Merged
merged 1 commit into from
Aug 11, 2023

Conversation

AA-Turner
Copy link
Contributor

@AA-Turner AA-Turner commented Aug 11, 2023

PR summary

Hi,

In sphinx-doc/sphinx#11518, @story645 noted that MPL's documentation failed when running with Sphinx 7.1. This PR disables the custom add_html_cache_busting() function within conf.py when running on Sphinx 7.1 and later, in favour of Sphinx's new native asset checksum support.

Thanks,
Adam

PR checklist

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. 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.

@QuLogic QuLogic added the Documentation: build building the docs label Aug 11, 2023
@QuLogic QuLogic added this to the v3.7-doc milestone Aug 11, 2023
@story645 story645 merged commit 48e2891 into matplotlib:main Aug 11, 2023
32 of 33 checks passed
@story645
Copy link
Member

Thanks so much for fixing this and extra thanks for doing it so quickly!

@lumberbot-app
Copy link

lumberbot-app bot commented Aug 11, 2023

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.7.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 48e28914d02dc5d50e3945b29f3d83da645b765f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #26493: Disable ``add_html_cache_busting`` on Sphinx 7.1+'
  1. Push to a named branch:
git push YOURFORK v3.7.x:auto-backport-of-pr-26493-on-v3.7.x
  1. Create a PR against branch v3.7.x, I would have named this PR:

"Backport PR #26493 on branch v3.7.x (Disable add_html_cache_busting on Sphinx 7.1+)"

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.

@lumberbot-app
Copy link

lumberbot-app bot commented Aug 11, 2023

Something went wrong ... Please have a look at my logs.

It seems that the branch you are trying to backport to does not exist.

@QuLogic
Copy link
Member

QuLogic commented Aug 18, 2023

@meeseeksdev backport to v3.8.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 18, 2023
ksunden added a commit that referenced this pull request Aug 18, 2023
…493-on-v3.8.x

Backport PR #26493 on branch v3.8.x (Disable ``add_html_cache_busting`` on Sphinx 7.1+)
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull request Aug 19, 2023
@QuLogic QuLogic modified the milestones: v3.7-doc, v3.8.0 Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: build building the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants