Feature: Implement hover-over referencing #126
Labels
code: low-code
Coding level: may need small amount of coding
For: Open Documentation Academy
Enough information to act and a good candidate to be part of the ODA efforts
The problem
Now that we have a functioning glossary page, one cool feature that would be awesome to have is the Wikipedia-style functionality that pops up a definition of a term or acronym when you hover over a link to the glossary.
The task
This functionality is available through the hoverxref Sphinx extension, which needs to be installed and tested to make sure the behaviour is correct.
Suggested approach
custom_conf.py
file. Note, this is sometimes trickier than it sounds!A test definition ("ACL") was included in the initial glossary implementation, on the
openldap/access-control
page. As long as the pop-up appears in your local build of the documentation when you hover over the term, and the text matches the expected text defined under the definition, then it's working :)The text was updated successfully, but these errors were encountered: