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

Add glossery/term support. #57

Closed
Daltz333 opened this issue Apr 12, 2020 · 4 comments
Closed

Add glossery/term support. #57

Daltz333 opened this issue Apr 12, 2020 · 4 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@Daltz333
Copy link
Contributor

This would be incredibly useful for this kind of situation.

@humitos
Copy link
Member

humitos commented Apr 12, 2020

Hi! Thanks for the suggestion.

If you are talking about https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary, I'd say that this is already supported.

You can just add 'term' to hoverxref_roles and it just should do the magic.

Although, I just realized that the content returned by the backend is not accurate. It includes the whole glossary and not only the term definition itself.

screenshot-sphinx-hoverxref readthedocs io-2020 04 12-04_53_23

I will try to take a look and see if I can fix this!

@humitos humitos added Accepted Accepted issue on our roadmap Improvement Minor improvement to code labels Apr 12, 2020
@humitos
Copy link
Member

humitos commented Apr 12, 2020

I found the issue an opened a PR that will fix it. It will render as,

Screenshot_2020-04-12_05-21-48

It hopefully will be merged and deployed next week.

Thanks!

@Daltz333
Copy link
Contributor Author

I was actually! Thank you for a quick and speedy implementation.

@humitos
Copy link
Member

humitos commented Apr 14, 2020

We deploy the fix today and it's already working. I'm closing this issue now. Please, let me know if it does work in your project as well.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

2 participants