{"id":14036910,"url":"https://github.com/readthedocs/sphinx-hoverxref","last_synced_at":"2025-04-08T11:16:28.869Z","repository":{"id":37592363,"uuid":"189852444","full_name":"readthedocs/sphinx-hoverxref","owner":"readthedocs","description":"Sphinx extension to show tooltips with content embedded when hover a reference.","archived":false,"fork":false,"pushed_at":"2025-03-31T00:19:45.000Z","size":2169,"stargazers_count":102,"open_issues_count":35,"forks_count":41,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-01T10:11:19.281Z","etag":null,"topics":["documentation","hoverxref","html","links","modal-dialogs","references","sphinx","sphinx-extension","tooltip"],"latest_commit_sha":null,"homepage":"https://sphinx-hoverxref.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readthedocs.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-02T13:52:53.000Z","updated_at":"2025-03-19T05:51:02.000Z","dependencies_parsed_at":"2023-12-18T10:28:23.705Z","dependency_job_id":"14a2fd65-3359-44a5-a793-04c1b96d88ed","html_url":"https://github.com/readthedocs/sphinx-hoverxref","commit_stats":{"total_commits":423,"total_committers":15,"mean_commits":28.2,"dds":0.2884160756501182,"last_synced_commit":"79d35c8020df74ede22a9d28b84770da762bf62b"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Fsphinx-hoverxref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Fsphinx-hoverxref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Fsphinx-hoverxref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Fsphinx-hoverxref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readthedocs","download_url":"https://codeload.github.com/readthedocs/sphinx-hoverxref/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247829512,"owners_count":21002997,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hoverxref","html","links","modal-dialogs","references","sphinx","sphinx-extension","tooltip"],"created_at":"2024-08-12T03:02:18.834Z","updated_at":"2025-04-08T11:16:28.845Z","avatar_url":"https://github.com/readthedocs.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"|PyPI version| |Docs badge| |License|\n\nsphinx-hoverxref\n================\n\n``sphinx-hoverxref`` is a Sphinx_ extension to add tooltips on the cross references of the documentation with the content of the linked section.\n\n\nExample\n-------\n\n.. image:: docs/sphinx-hoverxref-example.png\n\n\nInstallation\n------------\n\nYou can install sphinx-hoverxref from PyPI:\n\n::\n\n   pip install sphinx-hoverxref\n\nOr, alternatively, install it from GitHub directly (requires git):\n\n::\n\n   pip install git+https://github.com/readthedocs/sphinx-hoverxref\n\n\nConfiguration\n-------------\n\nAdd this extension in your ``conf.py`` file as:\n\n.. code-block:: python\n\n   extensions = [\n    # ... other extensions here\n\n    'hoverxref.extension',\n   ]\n\n\nDocumentation\n-------------\n\nCheck out the full documentation at https://sphinx-hoverxref.readthedocs.io/\n\n\n.. _Sphinx: https://www.sphinx-doc.org/\n\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-hoverxref.svg\n   :target: https://pypi.org/project/sphinx-hoverxref\n   :alt: Current PyPI version\n.. |Docs badge| image:: https://readthedocs.org/projects/sphinx-hoverxref/badge/?version=latest\n   :target: https://sphinx-hoverxref.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation status\n.. |License| image:: https://img.shields.io/github/license/readthedocs/sphinx-hoverxref.svg\n   :target: LICENSE\n   :alt: Repository license\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadthedocs%2Fsphinx-hoverxref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadthedocs%2Fsphinx-hoverxref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadthedocs%2Fsphinx-hoverxref/lists"}