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

Create Sphinx glossary #371

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Create Sphinx glossary #371

wants to merge 2 commits into from

Conversation

niksirbi
Copy link
Member

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

See #69. We want to have a place for precisely defining terms we use often. Where these terms appear in the docs, they can be cross-referenced to the glossary.

What does this PR do?

  • adds a glossary.md file (currently under the "User Guide")
  • populates the glossary with some initial terms
  • cross-links the defined terms from elsewhere in the docs

References

Closes #69

How has this PR been tested?

Local docs build.

Is this a breaking change?

No.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a glossary of common terms
1 participant