Skip to content

DOC: Only link to overall Zenodo DOI.#17491

Merged
timhoffm merged 8 commits intomatplotlib:masterfrom
QuLogic:less-doi
Jun 7, 2020
Merged

DOC: Only link to overall Zenodo DOI.#17491
timhoffm merged 8 commits intomatplotlib:masterfrom
QuLogic:less-doi

Conversation

@QuLogic
Copy link
Copy Markdown
Member

@QuLogic QuLogic commented May 23, 2020

PR Summary

This prevents the page from breaking due to requesting too many DOI images from Zenodo.

Fixes #16388.

PR Checklist

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

@QuLogic QuLogic added this to the v3.3.0 milestone May 23, 2020
Copy link
Copy Markdown
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Should we maybe link the (or a couple of the) most recent version(s) directly and give the general link if somebody needs something else?

Plus side: It's easier for the user than to have too navigate the doi page.

Down side: We have to update it with every release (but we've done that so far as well).

@tacaswell
Copy link
Copy Markdown
Member

If we want to put all / some of the other badges back we should probably write a helper script to automate downloading and caching them in _static.

While writing this message I talked my self into it being "easy". If I can get that working in ~30 minutes I'll open a PR with that, otherwise I'll merge this PR as a single badge is definitely better than a bunch of broken ones.

tacaswell
tacaswell previously approved these changes May 23, 2020
@tacaswell tacaswell dismissed their stale review May 23, 2020 19:37

I pushed a major change so can't review.

@tacaswell
Copy link
Copy Markdown
Member

It looks like there might also be a way to use the zenodo API to automate this further (https://developers.zenodo.org/#records), but I am over my time budget for this (my a factor of 2-3 I am terrible at estimating....)

Comment thread doc/devel/release_guide.rst Outdated
Comment thread doc/devel/release_guide.rst Outdated
Comment thread doc/devel/release_guide.rst Outdated
@tacaswell tacaswell added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label May 27, 2020
@QuLogic
Copy link
Copy Markdown
Member Author

QuLogic commented Jun 3, 2020

I added a few more links to the citation page in various places, to make it easier to find.

Comment thread tools/cache_zenodo_svg.py Outdated
@tacaswell
Copy link
Copy Markdown
Member

Re-running this also found a few bugs in the script 😥

Comment thread doc/citing.rst Outdated
QuLogic and others added 8 commits June 6, 2020 05:03
This prevents the page from breaking due to requesting too many DOI
images from Zenodo.

Fixes matplotlib#16388.
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@timhoffm timhoffm merged commit 7ac0ce6 into matplotlib:master Jun 7, 2020
@QuLogic QuLogic deleted the less-doi branch June 7, 2020 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rethink how we display DOI svg badges

3 participants