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

DOC: Don't try to link paths that are on a different drive #24592

Merged
merged 1 commit into from Dec 5, 2022

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Dec 3, 2022

PR Summary

This may happen if Python is installed on C: and Matplotlib is installed on some other drive. As the point of this extension is to create GitHub links for Matplotlib only, we should ignore all paths that cannot be relativized to it.

Fixes #24574

PR Checklist

Documentation and Tests

  • [n/a] Has pytest style unit tests (and pytest passes)
  • [n/a] Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [n/a] New plotting related features are documented with examples.

Release Notes

  • [n/a] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • [n/a] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [n/a] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

This may happen if Python is installed on C: and Matplotlib is installed
on some other drive. As the point of this extension is to create GitHub
links for Matplotlib *only*, we should ignore all paths that cannot be
relativized to it.

Fixes matplotlib#24574
@QuLogic QuLogic added the Documentation: build building the docs label Dec 3, 2022
@QuLogic QuLogic added this to the v3.6.3 milestone Dec 3, 2022
@tacaswell
Copy link
Member

Should we bail earlier if the module does not belong to us?

@ksunden ksunden merged commit 68832ff into matplotlib:main Dec 5, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 5, 2022
tacaswell added a commit that referenced this pull request Dec 5, 2022
…592-on-v3.6.x

Backport PR #24592 on branch v3.6.x (DOC: Don't try to link paths that are on a different drive)
@QuLogic QuLogic deleted the fix-doc-linkage branch December 5, 2022 21:42
@QuLogic
Copy link
Member Author

QuLogic commented Dec 5, 2022

Should we bail earlier if the module does not belong to us?

That's the next line.

@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: build building the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Extension error (sphinx.ext.linkcode) while building docs
3 participants