-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Fix missing-references.json. #17045
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
Conversation
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?).
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
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. |
Working on backporting this, just going to re-generate the json file on the 3.2.x branch. |
Merge pull request matplotlib#17045 from anntzer/docrefs Fix missing-references.json. Conflicts: doc/missing-references.json - fixed by fully regenerating
…-v3.2.x Backport PR #17045: Fix missing-references.json.
Fix missing-references.json. Conflicts: doc/missing-references.json - re-generated the skip list
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