Remove sphinx-hoverxref as an extension to the documentation build#3024
Remove sphinx-hoverxref as an extension to the documentation build#3024namurphy merged 12 commits intoPlasmaPy:mainfrom
sphinx-hoverxref as an extension to the documentation build#3024Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3024 +/- ##
=======================================
Coverage 95.41% 95.41%
=======================================
Files 108 108
Lines 9686 9686
Branches 1466 1466
=======================================
Hits 9242 9242
Misses 257 257
Partials 187 187 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@rocco8773 — I just enabled "link previews" in the Read the Docs add-ons, so the functionality of In the meantime, other PRs will have documentation built with both "link previews" and |
rocco8773
left a comment
There was a problem hiding this comment.
Looks good to me! I only left suggestions for the modified chang log entry and current change log to help preserve link backs.
Co-authored-by: Erik Everson <[email protected]>
|
Thank you for the review!
I had removed these because I had been thinking that links to a deprecated package could eventually break, but in retrospect it's highly likely that the old repo will stick around for a long time so we should be fine. |
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Back in #1353, we added
sphinx-hoverxrefas a Sphinx extension to the documentation build so that readers of the documentation could hover over links and get previews. Because that functionality is now included in Read the Docs add-ons, this extension has been deprecated.I had been planning to wait until after our next release to remove
sphinx-hoverxref, but there are some problems with the sphinx-dev doc build in the weekly tests (which are being run in #2998), so it seems better to remove it now.Closes #3009.