ubuntu/ubuntu-project-docs

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

Aperta

#28 aperta il 30 mag 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Makefile (108 fork)github user discovery
enhancementhelp wanteduntriaged

Metriche repository

Star
 (34 stelle)
Metriche merge PR
 (Merge medio 19g 8h) (58 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Verifica lo stato dell'addon RTD per i tooltip hover over, controlla se sono disponibili opzioni di configurazione e personalizzazione dello stile e identifica come disabilitare hoverxref e abilitare l'addon RTD nella configurazione di build della documentazione.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70