10000 Move version info to sidebar by timhoffm · Pull Request #16255 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Move version info to sidebar #16255

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 27, 2020
Merged

Move version info to sidebar #16255

merged 1 commit into from
Jan 27, 2020

Conversation

timhoffm
Copy link
Member

PR Summary

This is the first step of #16253.

It currently looks like this:
grafik

The contents will be adapted during the following steps.

timhoffm
timhoffm 8000 commented Jan 18, 2020
View reviewed changes
doc/index.rst
@@ -49,51 +49,8 @@ oriented interface or via a set of functions familiar to MATLAB users.
Documentation
-------------

This is the documentation for Matplotlib version |version|.
Copy link
Member Author

Choose a reason for hiding this comment

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

The section does not cover versions anymore. It's ok to remove this because we already have it more prominently in the title.
grafik

@timhoffm timhoffm added this to the v2.2.5 milestone Jan 18, 2020
@timhoffm timhoffm added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Jan 18, 2020
@timhoffm
Copy link
Member Author
timhoffm commented Jan 18, 2020 •
edited
Loading

I've marked this as release critical for 2.2.5. With this change we will be able to show up-to-date release info even on the 2.2.5 docs in a nice way. Since versions.html will be adapted during the follow-up PRs, it might not look great in the current inline position - or at least I don't want to have to care about that. So let's bring the future version container back to 2.2.5.

2.2.5 docs will stay relevant for a while because they are the last Python 2 compatible release; and I want to be able to display nice version info there.

@timhoffm
Copy link
Member Author

Build documentation:
https://circleci.com/gh/matplotlib/matplotlib/29485/artifacts/0//home/circleci/project/doc/build/html/index.html

@jklymak jklymak requested a review from story645 January 22, 2020 16:48
@timhoffm
Copy link
Member Author
timhoffm commented Jan 23, 2020 •
edited
Loading

Reused the old javascript code as discussed in the call to keep maximum browser support.

@timhoffm
Copy link
Member Author

Build documentation:
https://circleci.com/gh/matplotlib/matplotlib/29668/artifacts/0//home/circleci/project/doc/build/html/index.html

story645
story645 approved these changes Jan 24, 2020
View reviewed changes
Copy link
Member
@story645 story645 left a comment

Choose a reason for hiding this comment

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

Love this PR, seriously! Should probably be pitched to a different PR, but since you're already touching it, would it be too much work to move the sponsor button to the top? It's getting pushed really far down between both version boxes.

@timhoffm
Copy link
Member Author

I'd rather not move the donation link above the version infos. IMHO, the version info is more important and also what people are looking for much more often.
I'm not saying the donation link is not important. Announcing this prominently is desirable. However, I suspect that the amount of donations is tiny no matter where it is on the page (we probably have numbers on how much is donated to Matplotlib?).

Even including this change, the link won't be much more down compared to https://matplotlib.org/2.2.4/ because the search field moved into the nav bar. Additionally, it will move up again further with the planned change in #16253. Anyway, it should be visible without scrolling for all decent screen sizes.

@story645
Copy link
Member

we probably have numbers on how much is donated to Matplotlib?
Yeah, @tacaswell and Numfocus have that info. And yeah it's not much so I'm not gonna put up a fight over it.

@jklymak jklymak merged commit 5cb84e0 into matplotlib:master Jan 27, 2020
@lumberbot-app
Copy link
lumberbot-app bot commented Jan 27, 2020

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 v2.2.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 5cb84e070bcb4ebc5ddd5b1c8e5e8a1eccec5863
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #16255: Move version info to sidebar'
  1. Push to a named branch :
git push YOURFORK v2.2.x:auto-backport-of-pr-16255-on-v2.2.x
  1. Create a PR against branch v2.2.x, I would have named this PR:

"Backport PR #16255 on branch v2.2.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 27, 2020
@jklymak @meeseeksmachine
Backport PR matplotlib#16255: Move version info to sidebar
85d8d05
@meeseeksmachine meeseeksmachine mentioned this pull request Jan 27, 2020
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 27, 2020
@jklymak @meeseeksmachine
Backport PR matplotlib#16255: Move version info to sidebar
4e8a5b7
@meeseeksmachine meeseeksmachine mentioned this pull request Jan 27, 2020
Merged
timhoffm pushed a commit to timhoffm/matplotlib that referenced this pull request Jan 27, 2020
@jklymak @timhoffm
Backport PR matplotlib#16255: Move version info to sidebar
9ce2ec2
timhoffm pushed a commit to timhoffm/matplotlib that referenced this pull request Jan 27, 2020
@jklymak @timhoffm
Backport PR matplotlib#16255: Move version info to sidebar
bb00de9
@timhoffm timhoffm mentioned this pull request Jan 27, 2020
Merged
timhoffm added a commit that referenced this pull request Jan 27, 2020
@timhoffm
Merge pull request #16349 from meeseeksmachine/auto-backport-of-pr-16…
5b1be99 
…255-on-v3.2.x

Backport PR #16255 on branch v3.2.x (Move version info to sidebar)
timhoffm added a commit that referenced this pull request Jan 27, 2020
@timhoffm
Merge pull request #16348 from meeseeksmachine/auto-backport-of-pr-16…
f98a87e 
…255-on-v3.1.x

Backport PR #16255 on branch v3.1.x (Move version info to sidebar)
@timhoffm timhoffm deleted the sidebar-versions branch January 27, 2020 23:13
timhoffm pushed a commit to timhoffm/matplotlib that referenced this pull request Feb 1, 2020
@jklymak @timhoffm
Backport PR matplotlib#16255: Move version info to sidebar
45d09ac
tacaswell pushed a commit to timhoffm/matplotlib that referenced this pull request Feb 1, 2020
@jklymak @tacaswell
Backport PR matplotlib#16255: Move version info to sidebar
0ae46ae
tacaswell added a commit that referenced this pull request Feb 1, 2020
@tacaswell
Merge pull request #16352 from timhoffm/auto-backport-of-pr-16255-on-…
0c8db46 
…v2.2.x

Backport PR #16255 on branch v2.2.x (Move version info to sidebar)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@story645 story645 story645 approved these changes

@jklymak jklymak jklymak approved these changes

Assignees
No one assigned
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Milestone
v2.2.5
Development

Successfully merging this pull request may close these issues.
3 participants
@timhoffm @story645 @jklymak
0