fix: Convert relative path to a file in Mardown to its URL on GitHub. #1070
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: Shang Wang <samshang.wang@mail.utoronto.ca>
Signed-off-by: Charlie Truong <chtruong@nvidia.com> Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>
Signed-off-by: Terry Kong <terryk@nvidia.com> Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>
Signed-off-by: Zhiyu Li <zhiyul@nvidia.com> Signed-off-by: Zhiyu Li <zhiyul@NVIDIA.com> Co-authored-by: Yuki Huang <48991475+yuki-97@users.noreply.github.com> Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>
Signed-off-by: Terry Kong <terryk@nvidia.com> Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>
c08bbde to
6052183
Compare
terrykong
reviewed
Sep 5, 2025
There was a problem hiding this comment.
thanks @wangshangsam . a much needed QoL improvement. I just had a small comment
Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>
…o/RL into wangshangsam/fix-rel-src-link
Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>
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.
What does this PR do ?
This PR adds a converter (for the Sphinx documentation) that converts "the relative path to a file" in the Markdown to "the URL of the file on GitHub" being displayed on the documentation website.
This PR also fixes minor coding styles issues from a previous PR (#837).
Issues
Fixes #577
Usage
Screencast.from.2025-09-03.06.59.58.PM.webm
Before your PR is "Ready for review"
Pre checks:
Additional Information