Support glossary / term and sphinxcontrib-bibtex
#149
Conversation
humitos
force-pushed
the
humitos/glossary-citation
branch
4 times, most recently
from
95db41a to
b3a3e65
Compare
humitos
force-pushed
the
humitos/glossary-citation
branch
from
b3a3e65 to
a70f2b6
Compare
humitos
force-pushed
the
humitos/glossary-citation
branch
from
a70f2b6 to
6b41932
Compare
|
|
||
| See the :term:`sphinx:environment` definition in the glossary. | ||
|
|
||
| To enable ``hoverxref`` on glossary terms, you need to add ``'term'`` to :confval:`hoverxref_roles`. |
There was a problem hiding this comment.
Is this enabled by default? I feel like it should be..
There was a problem hiding this comment.
I prefer to not enable tooltips by default. The extension itself has a :hoverxref: role where you can manually specify which references you want to show tooltips on.
Besides, it has a simplified way to enable tooltips on all references by using hoverxref_auto_ref = True in your config file or selectively by role using hoverxref_roles.
| ------------------------------------- | ||
|
|
||
| If you want to show a tooltip on `sphinxcontrib-bibtex <https://sphinxcontrib-bibtex.readthedocs.io/en/latest/>`_ cites, | ||
| you just need to enable it in :confval:`hoverxref_domains` by adding ``'cite'`` to that list. |
There was a problem hiding this comment.
We should standardize where we put this info. It's at the bottom of the previous section, and top here. Probably a subhead like Enable this feature or similar?
There was a problem hiding this comment.
Probably a Enable this feature section may be too big for each of them since the content itself is really small. However, standardizing where to describe how to enable them makes sense to me.
Based on #146
Closes #96