Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Doc add sha to footer #10211

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
Apr 19, 2018
Merged

Doc add sha to footer #10211

merged 1 commit into from
Apr 19, 2018

Conversation

tacaswell
Copy link
Member

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@tacaswell tacaswell added this to the v2.1.1-doc milestone Jan 10, 2018
jklymak
jklymak reviewed Jan 10, 2018
View reviewed changes
Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

I think the footer is fine. I question the aesthetics of the front-page change, but thats subjective...

doc/index.rst Outdated
@@ -138,14 +141,14 @@ require changes to your existing code is logged in the :doc:`API changes
<api/api_changes>` file.

Toolkits
========
--------
Copy link
Member

Choose a reason for hiding this comment

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

I preferred how it looked as level-1...

https://5220-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/index.html
versus
https://matplotlib.org

Copy link
Member

Choose a reason for hiding this comment

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

Agreed, I think https://matplotlib.org/devdocs/ looks fine

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 issue that this is fixing the browser title which shows up as "Installation - Matplotlib 2.xxxxx documentation" vs "Matplotlib - Matplotlib 2.xxxx documentation".

I can seperate these two things, but we should fix the page title (as the browser sees it in <head><title>Title<\title><\head>)

Copy link
Member

Choose a reason for hiding this comment

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

The title is now fixed by #10870.

@tacaswell tacaswell modified the milestones: v2.1.1-doc, v2.2-doc Feb 12, 2018
@tacaswell tacaswell force-pushed the doc_add_sha_to_footer branch from 7d53aea to 6d414ee Compare March 28, 2018 07:05
@tacaswell
Copy link
Member Author

force-pushed the index.rst changes out of existence.

@dstansby dstansby merged commit f086513 into matplotlib:master Apr 19, 2018
lumberbot-app bot pushed a commit that referenced this pull request Apr 19, 2018
@dstansby
Backport PR #10211: Doc add sha to footer
48db85e
@lumberbot-app lumberbot-app bot mentioned this pull request Apr 19, 2018
Merged
@tacaswell tacaswell deleted the doc_add_sha_to_footer branch April 19, 2018 12:29
jklymak added a commit that referenced this pull request Apr 19, 2018
@jklymak
Merge pull request #11088 from matplotlib/auto-backport-of-pr-10211
0fe8e1e 
Backport PR #10211 on branch v2.2.2-doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic left review comments

@jklymak jklymak jklymak left review comments

@dopplershift dopplershift dopplershift approved these changes

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v2.2-doc
Development

Successfully merging this pull request may close these issues.
5 participants
@tacaswell @dopplershift @QuLogic @jklymak @dstansby