Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support aliases in glossary directives #1122

Open
agoose77 opened this issue Apr 17, 2024 · 0 comments
Open

Support aliases in glossary directives #1122

agoose77 opened this issue Apr 17, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@agoose77
Copy link
Collaborator

agoose77 commented Apr 17, 2024

Proposal

Sphinx's glossary directive supports aliases:

.. glossary::

   Term A
   Term B
     This is a definition

It would be nice to support this feature without introducing new esoteric syntax that only works in glossaries.

@rowanc1 and I had a meeting in which the following syntax was proposed:

:::{glossary}
Term A
: This is a definition

Term B
: {term}`Term A`
:::

This uses the {term} role to indicate that Term B is an alias of Term A.

@agoose77 agoose77 added the enhancement New feature or request label Apr 17, 2024
@agoose77 agoose77 changed the title Support ` {term}alias ` roles as aliases in glossary directives Support {term} roles as aliases in glossary directives Apr 17, 2024
@agoose77 agoose77 changed the title Support {term} roles as aliases in glossary directives Support aliases in glossary directives Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant