Use glossary terms for environment variables references in the docs #1442
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jean-Christophe Morin <[email protected]>
ssteinbach
reviewed
Oct 7, 2022
Signed-off-by: Jean-Christophe Morin <[email protected]>
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.
|
ssteinbach
approved these changes
Oct 10, 2022
MichaelPlug
pushed a commit
to MichaelPlug/OpenTimelineIO
that referenced
this pull request
Aug 5, 2023
…cademySoftwareFoundation#1442) * Use glossary terms for environment variables references in the docs * Add documentation for livereload Signed-off-by: Jean-Christophe Morin <[email protected]> Signed-off-by: Michele Spina <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.