Update absolute RTD links to relative paths#3958
Merged
Merged
Conversation
3314c28 to
dc3a658
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
SurbhiJainUSC
approved these changes
May 20, 2026
khatwanimohit
approved these changes
May 20, 2026
bvandermoon
approved these changes
May 20, 2026
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
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.
Description
This PR converts absolute ReadTheDocs links in the
docs/directory to relative paths. Previously, internal documentation links pointed to absolute URLs onmaxtext.readthedocs.io/en/latest/*(or specific versioned paths). They have been updated to use relative markdown paths (e.g.,../install_maxtext.md).This change is being made to support documentation versioning on ReadTheDocs. When a user is browsing a historical version of the documentation (such as
v0.2.2), clicking an internal link that uses an absolutelatestURL redirects them back to thelatestbranch instead of keeping them within thev0.2.2documentation context. Using relative paths ensures that links resolve to the correct page within the same version of the documentation currently being viewed.We updated 15 files under the
docs/directory, replacing absolute URLs with their corresponding relative paths based on their location in the directory structure.FIXES: b/515073747
Tests
We verified this change by successfully building the documentation locally on the TPU VM.
Commands to reproduce:
The build completed successfully with no new warnings, confirming that the relative paths are correctly resolved by Sphinx.
And build-docs workflow is passing
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.