Registry / web-framework / sphinx-hoverxref

sphinx-hoverxref

library1.4.2pypypi✓ verified 86d ago

A Sphinx extension that shows tooltips with embedded content when hovering over cross-references. Current version is 1.4.2 (2024-04-24). Release cadence is irregular, with occasional minor updates.

web-framework

pip install sphinx-hoverxref

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · SPHINX-HOVERXREF

sphinx-hoverxref

web-frameworkpythonv1.4.2

Install

5.3s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.4.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.4MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.3s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

hoverxref

✓ import hoverxref

✗ from sphinx_hoverxref import hoverxref

Enable hoverxref in your Sphinx conf.py. The extension must be added as 'sphinx_hoverxref.hoverxref' (not 'hoverxref').

# conf.py extensions = ['sphinx_hoverxref.hoverxref'] # Enable tooltip for all roles hoverxref_roles = ['any'] # Optional: set tooltip width hoverxref_tooltip_width = 300

Debug

Known issues

breakingVersion 1.0.0 changed the import path from 'hoverxref' to 'sphinx_hoverxref.hoverxref'. Old configs using extensions = ['hoverxref'] will fail.

fix

Use extensions = ['sphinx_hoverxref.hoverxref'] instead.

affects: >=1.0.0

gotchaThe extension requires Sphinx >= 1.8. Using an older Sphinx version may cause cryptic errors.

fix

Upgrade Sphinx to at least 1.8.

affects: all

gotchaTooltips may not appear if the role is not explicitly configured via hoverxref_roles. By default, no roles are enabled.

fix

Add hoverxref_roles = ['any'] or specify roles like ['class', 'func'].

affects: all

Upgrade

Version history

1.4.2latest on PyPI · released Nov 18, 2024

Audit

Dependencies

SphinxrequiredRequired; works with Sphinx >= 1.8

Agent activity

14 hits · last 30 days

node

Resources

githubhttps://github.com/readthedocs/sphinx-hoverxref ↗

packagehttps://pypi.org/project/sphinx-hoverxref/ ↗

docshttps://sphinx-hoverxref.readthedocs.io/ ↗