Fix document cross-references in .rst files and other gotchas #1111
Conversation
This file contains 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
Member
cary-ilm
commented
Jul 26, 2021
cary-ilm
commented
- The :ref: directive is the only one that Sphinx seems to recognize for cross-document references.
- Also, remove the "(New in 2.0)" in section headers. 2.0 was 8 years ago.
- Also, change a few stray references to "IlmImf" to "OpenEXR".
Signed-off-by: Cary Phillips <cary@ilm.com>
* The :ref: directive is the only one that Sphinx seems to recognize for cross-document references. * Also, remove the "(New in 2.0)" in section headers. 2.0 was 8 years ago. * Also, change a few stray references to "IlmImf" to "OpenEXR". Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
to cary-ilm/openexr
that referenced
this pull request
Sep 23, 2021
…ySoftwareFoundation#1111) * Fix internal references in .rst docs Signed-off-by: Cary Phillips <cary@ilm.com> * Fix document cross-references in .rst files * The :ref: directive is the only one that Sphinx seems to recognize for cross-document references. * Also, remove the "(New in 2.0)" in section headers. 2.0 was 8 years ago. * Also, change a few stray references to "IlmImf" to "OpenEXR". Signed-off-by: Cary Phillips <cary@ilm.com> * Change :ref: to :doc: for consistency Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
that referenced
this pull request
Sep 29, 2021
* Fix internal references in .rst docs Signed-off-by: Cary Phillips <cary@ilm.com> * Fix document cross-references in .rst files * The :ref: directive is the only one that Sphinx seems to recognize for cross-document references. * Also, remove the "(New in 2.0)" in section headers. 2.0 was 8 years ago. * Also, change a few stray references to "IlmImf" to "OpenEXR". Signed-off-by: Cary Phillips <cary@ilm.com> * Change :ref: to :doc: for consistency Signed-off-by: Cary Phillips <cary@ilm.com>
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.