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

Fix missing-references.json. #17045

Merged
merged 1 commit into from
Apr 6, 2020
Merged

Fix missing-references.json. #17045

merged 1 commit into from
Apr 6, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 6, 2020

I think what happened is that the way nested classes are referred to in
inheritance diagrams has improved (the qualified name is more correct
now), which caused missing-references.json to go out of sync.
Unfortunately this means missing-references.json can either be
compatible with sphinx<3.0 or with sphinx>3.0, but to be compatible with
both we'd likely need to generate one with both versions and merge the
two json files, which seems not worth it. Instead, just drop nitpicky
mode for older sphixes (sphinges?).

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

I think what happened is that the way nested classes are referred to in
inheritance diagrams has improved (the qualified name is more correct
now), which caused missing-references.json to go out of sync.
Unfortunately this means missing-references.json can either be
compatible with sphinx<3.0 or with sphinx>3.0, but to be compatible with
both we'd likely need to generate one with both versions and merge the
two json files, which seems not worth it.  Instead, just drop nitpicky
mode for older sphixes (sphinges?).
@anntzer anntzer added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Apr 6, 2020
@anntzer anntzer added this to the v3.2.2 milestone Apr 6, 2020
@timhoffm timhoffm merged commit 9f821e4 into matplotlib:master Apr 6, 2020
@lumberbot-app
Copy link

lumberbot-app bot commented Apr 6, 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 v3.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 9f821e49051da54d912f5177e74b66ea37096e7d
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #17045: Fix missing-references.json.'
  1. Push to a named branch :
git push YOURFORK v3.2.x:auto-backport-of-pr-17045-on-v3.2.x
  1. Create a PR against branch v3.2.x, I would have named this PR:

"Backport PR #17045 on branch v3.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.

@tacaswell
Copy link
Member

Working on backporting this, just going to re-generate the json file on the 3.2.x branch.

tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Apr 6, 2020
Merge pull request matplotlib#17045 from anntzer/docrefs

Fix missing-references.json.
Conflicts:
	doc/missing-references.json
          - fixed by fully regenerating
timhoffm added a commit that referenced this pull request Apr 7, 2020
…-v3.2.x

Backport PR #17045: Fix missing-references.json.
tacaswell pushed a commit to SidharthBansal/matplotlib that referenced this pull request Apr 8, 2020
Fix missing-references.json.
Conflicts:
	doc/missing-references.json
         - re-generated the skip list
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.

3 participants