Patch github link in torchtune docs header #1914
Merged
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
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/1914
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 25b9713 with merge base d0c6460 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
RdoubleA
approved these changes
Oct 28, 2024
svekars
approved these changes
Oct 29, 2024
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.
Fixes #1843
In our live docs we currently use the default PyTorch Sphinx theme for our header. This includes a Github icon that points to the main PyTorch repo by default, but for torchtune this isn't really where we want to point. This PR takes a similar approach to what is done in torchaudio here: adding a script to the footer to patch the href pointing to the PyTorch GH page. Unlike in torchaudio, however, we do not pin to an older version of the PyTorch Sphinx theme, so we identify the object to patch slightly differently.
Test plan:
Building docs locally and mousing over the GH icon we can see that it now points to the torchtune page.