Metadata-Version: 2.1
Name: sphinx-hoverxref
Version: 0.1b1
Summary: Sphinx extension to embed content in a tooltip on xref hover
Home-page: https://github.com/humitos/sphinx-hoverxref
Author: Manuel Kaufmann
Author-email: humitos@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/x-rst

|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
------------

::

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


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/


.. |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/humitos/sphinx-hoverxref.svg
   :target: LICENSE
   :alt: Repository license


