Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Unexpect behavior for referencing external packages #170

@rocco8773

Description

@rocco8773

Over at plasmapy we're trying to configure sphinx-hoverxref for our package (PlasmaPy/PlasmaPy#1437). In our documentation we liberally use intersphinx so we can provide link backs for our users. In setting up hoverxref I've noticed it doesn't provide tooltips for all valid sphinx syntax. For example, for all the following syntax intersphinx/sphinx will generate the proper links, but hoverxref will only work with the last set. For this I do have default_role = "obj".

.. no tooltip generated
`astropy.units.Quantity`
`~astropy.units.Quantity`
`Quantity <astropy.units.Quantity>`

.. tooltip generated
:class:`astropy.units.Quantity`
:class:`~astropy.units.Quantity`
:class:`Quantity <astropy.units.Quantity>`
:py:class:`Quantity <astropy.units.Quantity>`

Is this designed behavior? My expectation is that, if intersphinx can find the link, then hoverxref should be able to as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions