Added soil model abbreviation glossary and hoverxref glossary tool tips

[jacobcook1995]

Description

I've added a short glossary of soil model pool name abbreviations. I have also added the sphinx.hoverxref package, which I setup so that glossary item definitions can be viewed by tooltips. This is basically just a short demonstration to show the functionality. I plan on using this functionality as I extend/improve the soil model documentation.

I chose to add the glossary as a page within the soil model theory docs, but if others think that it's better to have a common glossary elsewhere I'm completely fine with doing that instead.

With hoverxref added we can basically add tooltips for any type of reference that we use. I did consider doing this for intersphinx references and for bibliographical references but decided against as I thought it could bog this PR down in side arguments.

I've built the docs and they can be viewed here. The tooltip examples can be seen here and here.

Fixes #479

Type of change

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist

• Make sure you've run the pre-commit checks: $ pre-commit run -a
• All tests pass: $ poetry run pytest

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works
• Relevant documentation reviewed and updated

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.57%. Comparing base (2bf6911) to head (bf6dd57).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #661   +/-   ##
========================================
  Coverage    94.57%   94.57%           
========================================
  Files           73       73           
  Lines         4645     4645           
========================================
  Hits          4393     4393           
  Misses         252      252           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[davidorme]

This looks great - very clean and saves a whole bunch of repeated definitions. I think we should have a project wide glossary. It might get very long, but it's all crossrefed with links so I don't think that matters.

Watch for it being poached in pyrealm very soon!

[jacobcook1995]

@davidorme, great! Yes if others also want to use this for their docs I agree that a project wide glossary makes most sense. Would the best place to put it be inside the "Reference" section?

[sallymatson]

Nice !! @jacobcook1995 from my perspective a project-wide glossary under Reference seems like a great idea.

[vgro]

Looks cool, very good idea