search

useblocks / sphinx-preview

Sphinx extension to show previews for links, if a mouse hover is detected.
MIT License
9 stars 5 forks source link

Document difference to sphinx-hoverxref #2

Open twodrops opened 1 year ago

twodrops commented 1 year ago

There seems to be another popular preview extension for Sphinx. https://sphinx-hoverxref.readthedocs.io/en/latest/

It is used in MySt examples. https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html

If a co-existence, make sense, it would be nice to document the differences in Readme.

danwos commented 1 year ago

I haven't used it, but I thought it could only be used when the docs are deployed on readthedocs. But maybe this has changed.

It also shows the first paragraph only and does not allow to navigate inside the shown text.

On the other side, the preview-window works better for chrome in sphinx-hoverxref.

jdillard commented 1 year ago

I haven't used it, but I thought it could only be used when the docs are deployed on readthedocs. But maybe this has changed.

Pretty sure that is still true.

There is also the recent https://github.com/chrisjsewell/sphinx-tippy which isn't dependent on being hosted on RTD.