Documentation | Fix glossary format (!188)

[Sebastian Huber (@sebhub)]

Sebastian Huber created a merge request: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/188

Project:Branches: sebhub/rtems-docs:fix-glossary-format to rtems/docs/rtems-docs:main
Author:   Sebastian Huber
Assignee: Sebastian Huber



## Summary

Fix glossary format

According to the
[MyST documentation](https://mystmd.org/guide/glossaries-and-terms#glossaries)
glossaries should have this format:

```
:::{glossary}
term
: Definition line 0
  Definition line 1
:::
```

However, this does not produce the expected output by Sphinx.
The `: Definition line 0` is added to the glossary term.
The `Definition line 1` is the definition.

What works is the formation mentioned in the compatibility note:

````markdown
```{glossary}
term
  Definition line 0
  Definition line 1
```
````


<!-- Default settings, if it is a dropdown it will set after submission -->

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/188
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20250825/23f3f858/attachment.htm>