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

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@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.1.tar.gz (27.9 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.1-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-hoverxref-1.0.1.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for sphinx-hoverxref-1.0.1.tar.gz
Algorithm Hash digest
SHA256 d5ccca48e2133ca0f3a20fccfbab235fe2d8a951ed9b7bf837802a88bdaaaa4e
MD5 e672de49538134f2efd39994dd275633
BLAKE2b-256 fce2cab118d9f1da4701b8d3135dce76a776660abafdc458971f26b362110364

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sphinx_hoverxref-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80660dcc10b35c6b12efb62d5601e000ab846825e86d09206354322fd0e9352f
MD5 b98302d42da07d74aa71d298e3a4364b
BLAKE2b-256 6d63fee01576a619464c701c18029025f009e391814a8e5f32a4aca7688a0d59

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