-
Notifications
You must be signed in to change notification settings - Fork 6
Unify docs build into a single build, support proper multiversion links #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
dad0529 to
62cc8db
Compare
adelbertc
commented
Nov 23, 2025
2 tasks
c7b55bb to
62cc8db
Compare
* Unify Sphinx build to build as one project instead of separate User Guide and Deployment Guide builds * Change hard-coded URLs to use Sphinx roles so the correct multiversion link can be interpolated at build time The goal of this change is to make the links in our docs version-aware after moving to multiversion docs in #40. Normally the way to do this is to reference roles like `:doc:` and `:ref:` instead of hard-coding URLs, but since we have cross-guide links we also have to unify the Sphinx build to make the builds aware of roles across all our docs.
fec55a9 to
d7dc32f
Compare
RyaliNvidia
reviewed
Nov 25, 2025
RyaliNvidia
reviewed
Nov 25, 2025
Co-authored-by: RyaliNvidia <[email protected]>
RyaliNvidia
approved these changes
Nov 26, 2025
3 tasks
ecolternv
approved these changes
Nov 26, 2025
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
nvidia-sphinx-themehardcodes to get the correct sidebar Table of Contents behavior after unifying the build and by extension thetoctreeThe goal of this change is to make the links in our docs version-aware after moving to multiversion docs in #40. Normally the way to do this is to reference roles like
:doc:and:ref:instead of hard-coding URLs, but since we have cross-guide links we also have to unify the Sphinx build to make the builds aware of roles across all our docs.NOTE: Our root README and similar docs still hard-code to
main. I figure this is an acceptable tradeoff at not complicating the build to account for this. All links within the actual docs pages should be cromulent.Issue #92
Checklist