python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

Glossary of technical terms

Open kierisi opened this issue 2 years ago • 4 comments

From the Bug Bash conversation with @lwasser:

* [jupyterbook has one!](https://jupyterbook.org/en/stable/reference/glossary.html)
* https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/reference/glossary.md

and it looks like there is a sphinx [glossary directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary) we can employ as well.

we could literally work on it at any time and perhaps the first step is just a list of terms in a hackmd or something that we can work on fleshing out with the community?

kierisi avatar Dec 28 '23 15:12 kierisi

Thank you!! so the steps here would be

  • [ ] First we create a list of terms that we want to define - perhaps in a hackmd file linked to this issue?
  • [ ] then we create definitions for those terms
  • [ ] Then we literally just add it to the sphinx book within a glossary directive.

it should be that simple.

lwasser avatar Dec 28 '23 21:12 lwasser

i'm going to close the open pr which is a demo of how this can work and just add the link here to that pr when we begin to work on this issue. this actually would be a really great thing to work on in sprints this summer. @kierisi maybe you could join us remotely in the sprints at pycon and scipy?! OR maybe we host a sprint for pyOpenSci?

lwasser avatar Mar 21 '24 16:03 lwasser

@lwasser I really love the idea of hosting a sprint for pyOpenSci. I'll put something in asana and add you as a collaborator - could be perfect to knock out this fall!

kierisi avatar Mar 21 '24 18:03 kierisi

Ok yay! We could even have review sprints Jesse!! Following the content you are creating !

lwasser avatar Mar 21 '24 20:03 lwasser