{"id":24622,"library":"sphinx-hoverxref","title":"sphinx-hoverxref","description":"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.","status":"active","version":"1.4.2","language":"python","source_language":"en","source_url":"https://github.com/readthedocs/sphinx-hoverxref","tags":["sphinx","extension","tooltip","cross-reference"],"install":[{"cmd":"pip install sphinx-hoverxref","lang":"bash","label":"pip"}],"dependencies":[{"reason":"Required; works with Sphinx >= 1.8","package":"Sphinx","optional":false}],"imports":[{"note":"Wrong import causes extension not found error.","wrong":"extensions = ['hoverxref']","symbol":"hoverxref_extension","correct":"extensions = ['sphinx_hoverxref.hoverxref']"},{"note":"Used to add custom roles if needed.","symbol":"hoverxref_roles","correct":"from sphinx_hoverxref import hoverxref_roles"}],"quickstart":{"code":"# conf.py\nextensions = ['sphinx_hoverxref.hoverxref']\n\n# Enable tooltip for all roles\nhoverxref_roles = ['any']\n\n# Optional: set tooltip width\nhoverxref_tooltip_width = 300","lang":"python","description":"Enable hoverxref in your Sphinx conf.py. The extension must be added as 'sphinx_hoverxref.hoverxref' (not 'hoverxref')."},"warnings":[{"fix":"Use extensions = ['sphinx_hoverxref.hoverxref'] instead.","message":"Version 1.0.0 changed the import path from 'hoverxref' to 'sphinx_hoverxref.hoverxref'. Old configs using extensions = ['hoverxref'] will fail.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Upgrade Sphinx to at least 1.8.","message":"The extension requires Sphinx >= 1.8. Using an older Sphinx version may cause cryptic errors.","severity":"gotcha","affected_versions":"all"},{"fix":"Add hoverxref_roles = ['any'] or specify roles like ['class', 'func'].","message":"Tooltips may not appear if the role is not explicitly configured via hoverxref_roles. By default, no roles are enabled.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use 'sphinx_hoverxref.hoverxref' instead of 'hoverxref'.","cause":"Wrong import path in conf.py extensions list.","error":"Extension error:\nCould not import extension hoverxref (exception: No module named 'hoverxref')"},{"fix":"Define hoverxref_roles as a list in conf.py after extensions are loaded.","cause":"Trying to use hoverxref_roles variable before assignment or without proper configuration.","error":"NameError: name 'hoverxref_roles' is not defined"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}