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

Add version to documentation header #10065

Merged
merged 1 commit into from Dec 23, 2017

Conversation

Projects
None yet
5 participants
@timhoffm
Copy link
Member

commented Dec 21, 2017

PR Summary

Version number

This adds a version number to the header section of the documentation. The motivation is to make it always obvious, which version of the documentation one is using:

grafik

Minor header height correction

While working on this, I realized that the header is probably slightly higher than intended (compare the white pixels below the github badge in the current docs).

grafik

The reason was a fixed-width logo, which takes slightly too much height (129px instead of 125px). I've changed this for a fixed height. As a result, the logo is slightly smaller, but I assume this is the actually desired layout.

@jklymak
Copy link
Contributor

left a comment

I'd left align. Looks funky for long version numbers.

https://4722-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/index.html

But otherwise I really like this! 👍

@jklymak jklymak added this to the v2.2 milestone Dec 21, 2017

@timhoffm

This comment has been minimized.

Copy link
Member Author

commented Dec 21, 2017

@jklymak Left-where? If you leave the height, but just left-align, long numbers clash with the "p".
grafik

When moving down further, short versions look a bit lost:
grafik

@jklymak

This comment has been minimized.

Copy link
Contributor

commented Dec 21, 2017

Oops, sorry, I didn't see how you were anchoring. If at all humanly possible I'd anchor below the second "t" or second "l". If thats too hard (sorry my css/html is a bit rusty), what you have is fine. After all folks can expect a few rough edges if they look at the Master version of the docs.

@timhoffm

This comment has been minimized.

Copy link
Member Author

commented Dec 21, 2017

With a bit more effort, one could also make the text background opaque, so that it's more readable but cuts the polar plot. Note that long version strings are restricted to development versions anyway.

grafik

@jklymak

This comment has been minimized.

Copy link
Contributor

commented Dec 21, 2017

I won't merge because I don't think the header is a "minor" documentation change, but I like the change.

@QuLogic

This comment has been minimized.

Copy link
Member

commented Dec 21, 2017

I agree with right alignment, though maybe 0.5 or even 0.25 em lower just to make the dot of the i not overlap the circle.

I don't really think there's any reason for the given header height. When I CSS-ified the GitHub banner, that's just the size that came out of the generator and matched the old image. I'm not sure one or the other is "right" in that regard.

@timhoffm timhoffm force-pushed the timhoffm:doc-version branch from e68bc68 to 1855b14 Dec 21, 2017

@timhoffm timhoffm force-pushed the timhoffm:doc-version branch from 1855b14 to 4ad7d68 Dec 21, 2017

@dstansby
Copy link
Contributor

left a comment

@tacaswell tacaswell modified the milestones: v2.2, v2.1.1-doc Dec 23, 2017

@tacaswell

This comment has been minimized.

Copy link
Member

commented Dec 23, 2017

If we do this we should probably regenerate old versions of the docs as well (at least 2.0 and 1.5) and re-publish those as well (I'll take care of that and all of the backporting and rebuilding).

@tacaswell tacaswell merged commit d24aea7 into matplotlib:master Dec 23, 2017

8 checks passed

ci/circleci: docs-python27 Your tests passed on CircleCI!
Details
ci/circleci: docs-python35 Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing af185be...4ad7d68
Details
codecov/project/library 62.84% (target 50%)
Details
codecov/project/tests 98.86% remains the same compared to af185be
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
lgtm analysis: Python No alert changes
Details

meeseeksdev bot pushed a commit that referenced this pull request Dec 23, 2017

tacaswell added a commit that referenced this pull request Dec 24, 2017

@timhoffm timhoffm deleted the timhoffm:doc-version branch Jan 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.