Reference terminology terms

[harrytodorov]

Rather than just listing a list of terminology in the Introduction section, we should make it easier for the reader to look these up.

Here are two ideas, which come up to my mind

1. Add a reference link to the term in the following sections
2. (Better option IMO) Hover-over (I guess the proper term for it is tooltip) text at each occurrence of the term (an example can be found on this page).

[pablo-de-andres]

Sphinx-hoverxref might be useful for that

[kysrpex]

The hover-over is just great. I would do both (hover+link) so that mobile users still can access the meaning of the term (or just make sure that a tap displays the tooltip for mobile users).

[pablo-de-andres]

Then we can move the terminology towards the end of the docs, since the user will mainly get there by the links

[harrytodorov]

/cib

[create-issue-branch]

Branch 83-Reference_terminology_terms created!

[harrytodorov]

After a discussion (see for more details #117), we have decided to halt the integration of tooltips into the docs, as maintaining and extending these long term would require too much manual labour.

If the developers of sphinx-hoverxref decide to add support for the Markdown format, we can reconsider continuing the work on this issue. We have opened an issue (regarding the support of Markdown) at sphinx-hoverxref's GitHub repository (see here)

[kysrpex]

After a discussion (see for more details #117), we have decided to halt the integration of tooltips into the docs, as maintaining and extending these long term would require too much manual labour.

If the developers of sphinx-hoverxref decide to add support for the Markdown format, we can reconsider continuing the work on this issue. We have opened an issue (regarding the support of Markdown) at sphinx-hoverxref's GitHub repository (see here)

Then I am closing this issue. We can reopen it if Markdown support is added to sphinx-hoverxref. Anyway, thank you for the research and the work!