Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document difference to sphinx-hoverxref #2

Open
twodrops opened this issue Jan 30, 2023 · 2 comments
Open

Document difference to sphinx-hoverxref #2

twodrops opened this issue Jan 30, 2023 · 2 comments

Comments

@twodrops
Copy link

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
Copy link
Member

danwos commented Jan 30, 2023

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

jdillard commented Feb 9, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants