Skip to content

Update Scipy intersphinx inventory link - #22431

Merged
timhoffm merged 2 commits into
matplotlib:mainfrom
QuLogic:scipy-inventory
Feb 9, 2022
Merged

timhoffm merged 2 commits into
matplotlib:mainfrom
QuLogic:scipy-inventory

Conversation

@QuLogic

@QuLogic QuLogic commented Feb 9, 2022

Copy link
Copy Markdown
Member

PR Summary

As noted in scipy/scipy#15545 the object inventory has moved. Though there's a redirect, it has paths like reference/.. which doubles the reference in the URL.

Additionally, we don't need explicit entries in reference_url because sphinx-gallery will get them from the intersphinx config.

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

As noted in scipy/scipy#15545 the object
inventory has moved. Though there's a redirect, it has paths like
`reference/..` which doubles the `reference` in the URL.
According to its docs, there's no need for any additional entries in
`reference_url` if intersphinx is being used.
@tacaswell tacaswell added this to the v3.5-doc milestone Feb 9, 2022
@tacaswell tacaswell closed this Feb 9, 2022
@tacaswell tacaswell reopened this Feb 9, 2022
@tacaswell

Copy link
Copy Markdown
Member

power cycled to re-build with fixed docs.

@timhoffm timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

CI failures are unrelated to the PR.

@timhoffm
timhoffm merged commit 0db7180 into matplotlib:main Feb 9, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Feb 9, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Feb 9, 2022
@QuLogic
QuLogic deleted the scipy-inventory branch February 9, 2022 20:46
timhoffm added a commit that referenced this pull request Feb 9, 2022
…431-on-v3.5.1-doc

Backport PR #22431 on branch v3.5.1-doc (Update Scipy intersphinx inventory link)
QuLogic added a commit that referenced this pull request Feb 9, 2022
…431-on-v3.5.x

Backport PR #22431 on branch v3.5.x (Update Scipy intersphinx inventory link)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants