Skip to main content

Build status Current PyPI version Documentation status Repository 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

docs/sphinx-hoverxref-example.png

Installation

pip install git+https://github.com/readthedocs/sphinx-hoverxref@master

Configuration

Add this extension in your conf.py file as:

extensions = [
 # ... other extensions here

 'hoverxref.extension',
]

Documentation

Check out the full documentation at https://sphinx-hoverxref.readthedocs.io/

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-hoverxref-1.0.0.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_hoverxref-1.0.0-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-hoverxref-1.0.0.tar.gz.

File metadata

  • Download URL: sphinx-hoverxref-1.0.0.tar.gz
  • Upload date:
  • Size: 27.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sphinx-hoverxref-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0af239b93e8dcae0caffe99a6beea4dc7d1efb738c085e9f6bcdf46fe7ae1195
MD5 a21238c88ff8da34650f116c95433b52
BLAKE2b-256 b3cc4db7885e611eddbaa5a251c897a01db1079f1b0435ca6201c34021c6d120

See more details on using hashes here.

File details

Details for the file sphinx_hoverxref-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_hoverxref-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 31.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sphinx_hoverxref-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8a052dfd755efd47d24acf7a8e0271c8781f3d990628d85758ea1ee0e83bc9e
MD5 9a49c20b6050716664ff0758ffc1024f
BLAKE2b-256 11fb9ea05b5176fa1bccd4905b3d6c81f1a716bf358dd0f01fd54ae500133de6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page