Skip to content

Make Definition Lists render as Glossaries in Sphinx #272

@choldgraf

Description

@choldgraf

In Sphinx, one can use a Glossary to define terminology and refer to those terms with {term}My term . Our definition lists look almost exactly like a glossary, but don't currently define the terms. Any reason not to make them behave like glossaries?

For example, here's the glossary syntax in MyST:

```{glossary}
My first term
  Some content

My second term
  Some more content
```

Whereas here's the same thing with definition lists:

My first term
: Some content

My second term
: Some more content

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