docs icon indicating copy to clipboard operation
docs copied to clipboard

Create a Sphinx Glossary for terms

Open djwfyi opened this issue 3 years ago • 0 comments

Is your feature request related to a problem? Please describe. N/A

Describe the solution you'd like Sphinx supports a glossary, as described at

  • https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html
  • https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-glossary

Steps to implement:

  1. Create a file to hold the glossary directive and contents, such as glossary.rst
  2. Add terms to the glossary file
  3. Create links to the terms by adding the :term: <word> directive to docs content

djwfyi avatar Apr 26 '22 19:04 djwfyi