parcels icon indicating copy to clipboard operation
parcels copied to clipboard

Documentation glossary

Open VeckoTheGecko opened this issue 9 months ago • 2 comments

Currently working on #2005 and realised that it might be good to define terms like "ocean circulation model" and "Level 0 datasets". I was thinking perhaps having a documentation glossary would generally be useful in Parcels as a quick definition for certain terms that are refferred to in multiple places - but doesn't make sense to have a dedicated page/section.

Thoughts @erikvansebille or is this something we can just achieve inline?

Looks like there is native support in Sphinx for a glossary https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html

VeckoTheGecko avatar May 27 '25 15:05 VeckoTheGecko

An interesting idea @VeckoTheGecko. Not sure how much effort we should put into this right now; but certainly good to make an inventory like this later on in the v4-development. Let's keep it on the back-burner for now?

erikvansebille avatar May 28 '25 13:05 erikvansebille

certainly good to make an inventory like this later on in the v4-development. Let's keep it on the back-burner for now?

Yes, agreed

VeckoTheGecko avatar May 28 '25 13:05 VeckoTheGecko