{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Sphinx extension that displays tooltips with linked section content when hovering over cross-references in documentation.","skillfed_tags":["sphinx-extension","documentation-ui","archived"],"use_cases":["Add hover previews to API documentation cross-references so readers can see function signatures without navigating away.","Enhance glossary links in technical documentation with inline term definitions visible on hover.","Improve internal documentation navigation by showing section summaries when hovering over table-of-contents links.","Create better user experience in large documentation sites where readers frequently jump between related sections."],"what_it_does":"sphinx-hoverxref is a Sphinx documentation extension that enhances cross-references by showing tooltips containing the content of the linked section when users hover over them. This improves documentation navigation by allowing readers to preview linked content without leaving the current page.\n\nThe extension integrates directly into Sphinx's build process and requires only sphinx and sphinxcontrib-jquery as runtime dependencies. Configuration is minimal\u2014just adding 'hoverxref.extension' to the extensions list in conf.py. However, the project repository is archived and abandoned, meaning no active maintenance or updates are occurring.","worth_installing":"Yes, if your Sphinx documentation build is stable and you need hover tooltips on cross-references. The extension has low install friction and permissive licensing. However, exercise caution: the repository is archived and abandoned, so no bug fixes or compatibility updates will be released. Test thoroughly with your current Sphinx version before relying on it in production documentation."},"id":"sphinx-hoverxref","links":{"html":"https://skillfed.io/packages/sphinx-hoverxref","md":"https://skillfed.io/packages/sphinx-hoverxref.md","pypi":"https://pypi.org/project/sphinx-hoverxref/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2024-11-18","license_spdx":null,"license_treatment":"permissive","name":"sphinx-hoverxref","python_support":"unspecified","summary":"Sphinx extension to show tooltips with content embedded when hover a reference."},"popularity":{"monthly_downloads":85819,"position":13897,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.4.2"}