Skip to content

Allow multiple terms for the same definition in glossary #1127

Description

@nicobo

Describe the feature you'd like to request

Sphinx's .. glosssary:: directive allows to have several terms attached to one single definition.
This is super useful to keep cleaner documents when referencing sometimes the singular, sometimes the plural form of a given term, for instance (or with different writings, or coupled with another usual term, etc.).

E.g.

.. glossary::

   term 1
   term 2
      Definition of both terms.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary-directive

I could not make this work in Markdown with MyST Parser, so I assume it just does not work.

Unsuccessful example I've tried :

# Glossary

{.glossary}
gluster
glusterfs
:   The software used to provide the network disk.

Maybe related to #272

Describe the solution you'd like

The markdown example above should work.

Describe alternatives you've considered

The only alternative I've thought of is to have the glossary in reStructuredText, but it does not put a link on the terms in other documents (so it's useless).
And it is not markdown.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions