search

pyOpenSci / python-package-guide

scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
72 stars 43 forks source link

Enh: add glossary #167

Closed lwasser closed 3 months ago

lwasser commented 5 months ago

@kierisi it turns out that a glossary isn't an additional infra it's just a directive.

To make sure terms highlight and link to the glossary you can use this syntax:

How you call the glossary:

{term}sdist

i had thought it might automagically pick up the terms each time we add one but that is not the case. we will have to add references to the thing defined in the glossary! but this should get us started! and you are welcome to submit a fresh PR if adding to this one feels like more work!! i didn't really do much here but figure out how work :)

willingc commented 3 months ago

Doing a monthly review of PRs, should we close or finish off this PR? @lwasser

lwasser commented 3 months ago

@willingc thank you!! i'll close it. i left a link to this as an example in the open issue #141 but we can still close this issue! ✨ thank you for doing this monthly issue round up!!