-
Notifications
You must be signed in to change notification settings - Fork 272
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
Use glossary terms for environment variables references in the docs #1442
Use glossary terms for environment variables references in the docs #1442
Conversation
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
very nice!
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1442 +/- ##
==========================================
- Coverage 86.38% 78.85% -7.54%
==========================================
Files 201 203 +2
Lines 20854 22246 +1392
Branches 2298 4517 +2219
==========================================
- Hits 18014 17541 -473
- Misses 2244 2437 +193
- Partials 596 2268 +1672
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
…cademySoftwareFoundation#1442) * Use glossary terms for environment variables references in the docs * Add documentation for livereload Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com> Signed-off-by: Michele Spina <michelespina96@gmail.com>
Summarize your change.
Simple PR that makes use of glossaries to define/document environment variables. This allows to reference environment variables from other places in the docs.
See https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-glossary.
The rendered docs can be seen at https://opentimelineio--1442.org.readthedocs.build/en/1442 and an example of how a reference looks like can be seen at https://opentimelineio--1442.org.readthedocs.build/en/1442/tutorials/write-an-adapter.html#custom-adapters.