docs: use the link shortener

[12rambau]

In the recent version of the pydata-sphinx-theme (that you use through the sphinx-book-theme) we implemented a link shortener that would (I think) be a good replacement for the custom :issue: role. I was passing by, I made a small adjustment so you can see the diff and if you don't like it, simply close my PR.

https://xray--8700.org.readthedocs.build/en/8700/internals/extending-xarray.html

[welcome]

Thank you for opening this pull request! It may take us a few days to respond here, so thank you for being patient.
If you have questions, some answers may be found in our contributing guidelines.

[mathause]

The example is at https://xray--8700.org.readthedocs.build/en/8700/internals/extending-xarray.html (towards the bottom).

Looks nice.

• Could be a bit more difficult to replace if we ever move away from sphinx-book-theme?
• Is the idea that it renders more nicely in a raw rst?
• Is there a way to define a "first-party" package?
• Does it also work for pull requests?

[12rambau]

This is inherited from the pydata-sphinx-theme and we documented it here

Could be a bit more difficult to replace if we ever move away from sphinx-book-theme?

There is a trade of for nice looking things and we were forced to go beyond what sphinx had to offer, I guess only you can answer this one. I personnaly think it worth the shot.

Is the idea that it renders more nicely in a raw rst?

The idea is just to use the functionalities of the newly elected theme to there fullest, the previous one was working as well.

Is there a way to define a "first-party" package?

The first party package is detected from the link structure

Does it also work for pull requests?

Works for most of the Github like items (organization, users, repo, issues, comments, PR, tags...)

[dcherian]

Thanks @12rambau

[welcome]

Congratulations on completing your first pull request! Welcome to Xarray! We are proud of you, and hope to see you again!