Give precedence to instant previews over title tooltips

[pawamoy]

Context

mkdocstrings uses mkdocs-autorefs to handle cross-references. What we call cross-references are links to documented symbols (for example Python objects), whether they are internal to the current docs, or external (appearing on other sites).

A cross-reference will usually only display a short symbol name, for example Car instead of the Fully Qualified Name (FQN) carlicious.models.Car. To provide more information to readers, mkdocs-autorefs sets the FQN as HTML title attribute, so that hovering on the link shows the FQN.

The issue however is that the presence of the title attribute prevents instant previews from showing up (whether they're enabled globally or for this link specifically).

Description

I'd like instant previews to always show up, even if the link has a title.

I'd like to let mkdocs-autorefs set titles, always, without it preventing the instant previews feature from working. The alternatives are:

• We try to be smart and set titles or not depending on whether instant previews are enabled and how, and whether the links are internal/external (since instant previews only work for internal links anyway).
• We add a configuration option to deactivate titles.

Related links

• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=instant+prev#instant-previews

Use Cases

Keep providing tooltips with extra info to readers on link hover, while allowing writers to enable instant previews without feature clash.

Visuals

No response

Before submitting

• I have read and followed the change request guidelines.
• I have verified that my idea is a change request and not a bug report.
• I have ensured that, to the best of my knowledge, my idea will benefit the entire community.
• I have included relevant links to the documentation, related issues, and discussions to underline the need for my idea.

[squidfunk]

Thanks for suggesting. We need to evaluate, whether instant previews should always "trump" titles.

[squidfunk]

Fixed in 573ea60dc – Instant previews will now have precedence over tooltips. If instant previews are mounted, we now delete the title attribute, as it will otherwise be overlayed. In the future, we might run into cases where we want to show the title as part of the instant preview, but we'll leave that for when this surfaces as an actual use case.

[pawamoy]

Awesome, thank you @squidfunk!