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

DOC: restore SHA to footer #24781

Merged
merged 2 commits into from Feb 10, 2023
Merged

Conversation

tacaswell
Copy link
Member

PR Summary

Depends on matplotlib/mpl-sphinx-theme#54 being merged.

We used to include the exact commit used to build the docs in the footer (see https://matplotlib.org/3.4.3/index.html) however that got lost as part of the move to mpl-sphinx-theme. This adds the option to put this in the footer again.

@tacaswell
Copy link
Member Author

This will also require a pin forward on the version of mpl-sphinx-theme we require to build the docs.

@QuLogic
Copy link
Member

QuLogic commented Dec 20, 2022

There is no pin on main, only the release branch.

@tacaswell
Copy link
Member Author

image

@QuLogic
Copy link
Member

QuLogic commented Jan 6, 2023

With a small bit of CSS:

.bd-footer__inner {
	display: flex;
	flex-wrap: wrap;
}
.footer-item {
	margin: 0 0.5em;
}
.footer-item:first-child {
	width: 100%;
}

we can get it together like before:
image

which I'm not sure if that should end up in mpl-sphinx-theme?

@ksunden ksunden added the Documentation: website layout/behavior/styling changes label Jan 25, 2023
@tacaswell tacaswell marked this pull request as ready for review February 10, 2023 19:05
@tacaswell
Copy link
Member Author

I am in favor of leaving the CSS tweaking for later.

@jklymak
Copy link
Member

jklymak commented Feb 10, 2023

Feel free to self-merge if mpl-sphinx-theme is already at 3.7

@tacaswell
Copy link
Member Author

Feel free to self-merge if mpl-sphinx-theme is already at 3.7

it is in a funny state (due to branch protections I could not push the version bumping commit to main but I could push the tag, will fix that soon), but there is a release on pypi.

@tacaswell
Copy link
Member Author

manually cancelled the appevyor to unblock it for other PRs.

@ksunden ksunden merged commit 73909bc into matplotlib:main Feb 10, 2023
@lumberbot-app
Copy link

lumberbot-app bot commented Feb 10, 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 73909bcb408886a22e2b84581d6b9e6d9907c813
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #24781: DOC: restore SHA to footer'
  1. Push to a named branch:
git push YOURFORK v3.7.x:auto-backport-of-pr-24781-on-v3.7.x
  1. Create a PR against branch v3.7.x, I would have named this PR:

"Backport PR #24781 on branch v3.7.x (DOC: restore SHA to footer)"

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.

@tacaswell tacaswell deleted the mnt/restore_doc_sha branch February 10, 2023 22:08
@tacaswell
Copy link
Member Author

Will backport this as part of #25194 .

tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Feb 10, 2023
DOC: restore SHA to footer
(cherry picked from commit 73909bc)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Feb 10, 2023
DOC: restore SHA to footer
(cherry picked from commit 73909bc)
ksunden added a commit to tacaswell/matplotlib that referenced this pull request Feb 13, 2023
DOC: restore SHA to footer
(cherry picked from commit 73909bc)
ksunden added a commit to tacaswell/matplotlib that referenced this pull request Feb 13, 2023
DOC: restore SHA to footer
(cherry picked from commit 73909bc)
@ksunden
Copy link
Member

ksunden commented Feb 14, 2023

Backport included in 3.7.0 final preparation

@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: website layout/behavior/styling changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants