ubuntu/ubuntu-project-docs

[Future] Switch from hoverxref to default RTD hover-over

Open

#28 opened on May 30, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Makefile (95 forks)github user discovery
enhancementhelp wanteduntriaged

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (Avg merge 19d 8h) (58 merged PRs in 30d)

Description

RTD has recently developed an addon that replaces hoverxref, so that hover-over tooltips can be enabled for projects via the RTD admin panel.

However, there is currently no configuration possible of this feature (although it's on their roadmap), so it is enabled on every kind of link (including normal hyperlinks).

In addition, we currently can't configure the default styling of the tooltips provided by the RTD addon, and the default colours and fonts chosen are problematic from an accessibility PoV (very low contrast, very small text).

However, once these issues are resolved and we have the ability to customise the feature to be better aligned with our own styling, we should switch from hoverxref to the RTD addon.

Contributor guide

Research direction
Check the status of the RTD addon for hover over tooltips, verify if configuration and styling customization options are available, and identify how to disable hoverxref and enable the RTD addon in the documentation build configuration.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70