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

automatic glossary / bibliography creation #68

Open
mawieland opened this issue Feb 13, 2023 · 1 comment
Open

automatic glossary / bibliography creation #68

mawieland opened this issue Feb 13, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@mawieland
Copy link
Contributor

This helps keep a list of abbreviations organized in bigger documents.

Should be accessible via a role directly in markdown. Similar to sphinx-needs

for example:

## chapter 1
:abb: `sne` is an extension to sphinx-needs which enables access to various commercial ticket systems.

would show:


chapter 1

SNE is an extension to sphinx-needs which enables access to various commercial ticket systems.


linking to a paper or other document could be done in a similar fashion.

This feature might also be useful in a HTML documentation context.
One possible solution is to create a separate sphinx extension to work with both HTML and simplepdf that auto-creates a glossary + bibliography file.

@mawieland mawieland added the enhancement New feature or request label Feb 13, 2023
@danwos
Copy link
Member

danwos commented Feb 13, 2023

It must be automatically?
So Sphinx glossary is not a valid solution?
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html

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

2 participants