|PyPI version| |Docs badge| |License|
sphinx-hoverxref
================
``sphinx-hoverxref`` is a Sphinx_ extension to add tooltips on the cross references of the documentation with the content of the linked section.
Example
-------
.. image:: docs/sphinx-hoverxref-example.png
Installation
------------
You can install sphinx-hoverxref from PyPI:
::
pip install sphinx-hoverxref
Or, alternatively, install it from GitHub directly (requires git):
::
pip install git+https://github.com/readthedocs/sphinx-hoverxref
Configuration
-------------
Add this extension in your ``conf.py`` file as:
.. code-block:: python
extensions = [
# ... other extensions here
'hoverxref.extension',
]
Documentation
-------------
Check out the full documentation at https://sphinx-hoverxref.readthedocs.io/
.. _Sphinx: https://www.sphinx-doc.org/
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-hoverxref.svg
:target: https://pypi.org/project/sphinx-hoverxref
:alt: Current PyPI version
.. |Docs badge| image:: https://readthedocs.org/projects/sphinx-hoverxref/badge/?version=latest
:target: https://sphinx-hoverxref.readthedocs.io/en/latest/?badge=latest
:alt: Documentation status
.. |License| image:: https://img.shields.io/github/license/readthedocs/sphinx-hoverxref.svg
:target: LICENSE
:alt: Repository license
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-hoverxref",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "tooltip, modal, hover, hoverxref, sphinx, documentation",
"author": null,
"author_email": "Manuel Kaufmann <humitos@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/27/14/840bf471adb0322ca36b1f577bd966871ae5e88490ac53f741966dadba52/sphinx_hoverxref-1.4.1.tar.gz",
"platform": null,
"description": "|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",
"bugtrack_url": null,
"license": null,
"summary": "Sphinx extension to show tooltips with content embedded when hover a reference.",
"version": "1.4.1",
"project_urls": {
"Documentation": "https://sphinx-hoverxref.readthedocs.io/",
"Source": "https://github.com/readthedocs/sphinx-hoverxref",
"Tracker": "https://github.com/readthedocs/sphinx-hoverxref/issues"
},
"split_keywords": [
"tooltip",
" modal",
" hover",
" hoverxref",
" sphinx",
" documentation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5c43e10f3e959295464946d409620babc68b35459807ab8e906ae254252b9e1f",
"md5": "9be8b304d5316b8db7b31af7905815bf",
"sha256": "be4c8afecf4d6f9b1ecccafd7be736fd8a761c9ab2db36140ca1ee40196916a8"
},
"downloads": -1,
"filename": "sphinx_hoverxref-1.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9be8b304d5316b8db7b31af7905815bf",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 32338,
"upload_time": "2024-09-09T14:34:38",
"upload_time_iso_8601": "2024-09-09T14:34:38.962700Z",
"url": "https://files.pythonhosted.org/packages/5c/43/e10f3e959295464946d409620babc68b35459807ab8e906ae254252b9e1f/sphinx_hoverxref-1.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2714840bf471adb0322ca36b1f577bd966871ae5e88490ac53f741966dadba52",
"md5": "67e1a0c06dde25ca80e16449ab5d9ff5",
"sha256": "b5e302ff5ca953ca3f271d9b9f09d92f59158335dfa8e9cfac415d1686a3f27b"
},
"downloads": -1,
"filename": "sphinx_hoverxref-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "67e1a0c06dde25ca80e16449ab5d9ff5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1716366,
"upload_time": "2024-09-09T14:34:43",
"upload_time_iso_8601": "2024-09-09T14:34:43.321372Z",
"url": "https://files.pythonhosted.org/packages/27/14/840bf471adb0322ca36b1f577bd966871ae5e88490ac53f741966dadba52/sphinx_hoverxref-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 14:34:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "readthedocs",
"github_project": "sphinx-hoverxref",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"tox": true,
"lcname": "sphinx-hoverxref"
}
JSON
