{"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":[{"wrong":"from sphinx_hoverxref import hoverxref","symbol":"hoverxref","correct":"import hoverxref"}],"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,"search_vec":"'-04':24 '-24':25 '1.4.2':22 '2024':23 'cadenc':27 'content':12 'cross':17,38 'cross-refer':16,37 'current':19 'embed':11 'extens':6,35 'hover':14 'hoverxref':3 'irregular':29 'minor':32 'occasion':31 'refer':18,39 'releas':26 'show':8 'sphinx':2,5,34 'sphinx-hoverxref':1 'tooltip':9,36 'updat':33 'version':20","created_at":"2026-05-01T08:14:03.615594+00:00","updated_at":"2026-05-01T08:14:03.615594+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"1.4.2","cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/readthedocs/sphinx-hoverxref","docs":"https://sphinx-hoverxref.readthedocs.io/","changelog":null,"pypi":"https://pypi.org/project/sphinx-hoverxref/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["web-framework"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-08-02","install_tag":null}}