Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 15, 2025

The sphinx-hoverxref extension has been deprecated by ReadTheDocs. Link preview functionality is now provided via the RTD admin dashboard (Settings > Addons > Link previews).

Changes

  • Remove sphinx-hoverxref from root requirements.txt
  • Remove .hxr-hoverxref CSS styling from docs/source/_static/custom.css

No RST files used the :hoverxref: role and the extension was not configured in conf.py, so only the dependency and unused CSS needed removal.

Original prompt

This section details on the original issue you should resolve

<issue_title>hoverxref deprecated</issue_title>
<issue_description>https://github.com/readthedocs/sphinx-hoverxref</issue_description>

Comments on the Issue (you are @copilot in this section)

@jpfeuffer Their link preview addon is trash. So basically we have to say goodbye to hoverrefs.

Thank you sphinx.</comment_new>
<comment_new>@jpfeuffer
Probably all the extra logic for hoverrefs needs to go. Maybe then the links work as normal.</comment_new>
<comment_new>@timosachsenberg
This extension has been deprecated. Users are advised to enable the "Link previews" option in "Settings" > "Addons" > "Link previews"
in the Read the Docs admin dashboard for their project to get the same functionality as this extension.

For more information, please see:

  1. https://docs.readthedocs.com/platform/stable/link-previews.html
  2. https://about.readthedocs.com/blog/2024/07/addons-by-default/</comment_new>

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@coderabbitai
Copy link

coderabbitai bot commented Dec 15, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Note

Free review on us!

CodeRabbit is offering free reviews until Wed Dec 17 2025 to showcase some of the refinements we've made.

Comment @coderabbitai help to get the list of available commands and usage tips.

- Remove sphinx-hoverxref from root requirements.txt
- Remove hoverxref CSS styling from docs/source/_static/custom.css

The sphinx-hoverxref extension has been deprecated by ReadTheDocs.
Users should enable "Link previews" in the RTD admin dashboard instead.

Co-authored-by: timosachsenberg <5803621+timosachsenberg@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove deprecated hoverxref extension usage Remove deprecated sphinx-hoverxref extension Dec 15, 2025
@timosachsenberg timosachsenberg marked this pull request as ready for review December 15, 2025 19:46
@timosachsenberg timosachsenberg merged commit d01034d into master Dec 15, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

hoverxref deprecated

2 participants