Skip to content

Remove sphinx-hoverxref as an extension to the documentation build#3024

Merged
namurphy merged 12 commits intoPlasmaPy:mainfrom
namurphy:remove-sphinxhoverxref
Jun 24, 2025
Merged

Remove sphinx-hoverxref as an extension to the documentation build#3024
namurphy merged 12 commits intoPlasmaPy:mainfrom
namurphy:remove-sphinxhoverxref

Conversation

@namurphy
Copy link
Member

Back in #1353, we added sphinx-hoverxref as 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.

@namurphy namurphy requested a review from a team as a code owner May 27, 2025 21:27
@namurphy namurphy requested review from ejohnson-96 and removed request for a team May 27, 2025 21:27
@github-actions github-actions bot added docs PlasmaPy Docs at http://docs.plasmapy.org requirements Related to updating requirements contributor guide packaging Related to packaging or distribution documentation infrastructure python Pull requests that update Python code run comprehensive tests Add this label to run comprehensive tests in CI labels May 27, 2025
@namurphy namurphy requested review from rocco8773 and removed request for ejohnson-96 May 27, 2025 21:27
@codecov
Copy link

codecov bot commented May 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.41%. Comparing base (16fbee2) to head (8206d2f).
⚠️ Report is 55 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@namurphy
Copy link
Member Author

@rocco8773 — I just enabled "link previews" in the Read the Docs add-ons, so the functionality of sphinx-hoverxref will live on (and not just in our hearts!).

In the meantime, other PRs will have documentation built with both "link previews" and sphinx-hoverxref enabled, which may cause problems.

@namurphy namurphy added the status: ready for review PRs that are ready for code review label May 27, 2025
Copy link
Member

@rocco8773 rocco8773 left a comment

Choose a reason for hiding this comment

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

Looks good to me! I only left suggestions for the modified chang log entry and current change log to help preserve link backs.

namurphy

This comment was marked as outdated.

@namurphy
Copy link
Member Author

Thank you for the review!

I only left suggestions for the modified chang log entry and current change log to help preserve link backs.

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.

@namurphy
Copy link
Member Author

pre-commit.ci autofix

@namurphy namurphy removed the run comprehensive tests Add this label to run comprehensive tests in CI label Jun 12, 2025
@github-actions github-actions bot added the run comprehensive tests Add this label to run comprehensive tests in CI label Jun 12, 2025
@namurphy namurphy removed the run comprehensive tests Add this label to run comprehensive tests in CI label Jun 24, 2025
@github-actions github-actions bot added the run comprehensive tests Add this label to run comprehensive tests in CI label Jun 24, 2025
@namurphy namurphy merged commit c87c163 into PlasmaPy:main Jun 24, 2025
43 of 44 checks passed
@namurphy namurphy deleted the remove-sphinxhoverxref branch June 24, 2025 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor guide docs PlasmaPy Docs at http://docs.plasmapy.org documentation infrastructure packaging Related to packaging or distribution python Pull requests that update Python code requirements Related to updating requirements run comprehensive tests Add this label to run comprehensive tests in CI status: ready for review PRs that are ready for code review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Should we drop sphinx-hoverxref?

2 participants