Metadata-Version: 2.1
Name: sphinx-hoverxref
Version: 0.4b1
Summary: Sphinx extension to embed content in a tooltip on xref hover
Home-page: https://github.com/readthedocs/sphinx-hoverxref
Author: Manuel Kaufmann
Author-email: humitos@gmail.com
License: MIT
Project-URL: Documentation, https://sphinx-hoverxref.readthedocs.io/
Project-URL: Source, https://github.com/readthedocs/sphinx-hoverxref
Project-URL: Tracker, https://github.com/readthedocs/sphinx-hoverxref/issues
Description: |Build| |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.
        
        .. warning::
        
            This extension is currently in Beta state.
            This means that there may be some things not well supported or unexpected behavior.
            If you find any issue, please `report it in the issue tracker <https://github.com/readthedocs/sphinx-hoverxref/issues>`_.
        
        
        Example
        -------
        
        .. image:: 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:
        
        .. 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/
        
        
        .. |Build| image:: https://travis-ci.org/readthedocs/sphinx-hoverxref.svg?branch=master
           :target: https://travis-ci.org/readthedocs/sphinx-hoverxref
           :alt: Build status
        .. |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
        
Keywords: tooltip hoverxref sphinx
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/x-rst
