Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glossary terms for abbreviations in documentation #479

Closed
jacobcook1995 opened this issue Jul 2, 2024 · 0 comments · Fixed by #661
Closed

Glossary terms for abbreviations in documentation #479

jacobcook1995 opened this issue Jul 2, 2024 · 0 comments · Fixed by #661
Assignees

Comments

@jacobcook1995
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
The soil model (and I'm guessing the other models) uses a lot of acronyms, e.g. MAOM for mineral associated organic matter. Having to write out these acronyms every time in docstrings/documentation is tedious, but just writing out the acronyms leads to fairly unreadable documentation.

Describe the solution you'd like
The sphinx extension hoverxref allows us to define a glossary which is then used to generate tooltips explaining terms (and in this case acronyms). I will look into this for the soil model as it is pretty acronym heavy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants