#82 - Add link checking to documentation #83
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
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
changed the title
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
had a problem deploying
to
internal-ci
GitHub Actions
Failure
RyaliNvidia
had a problem deploying
to
internal-ci
GitHub Actions
Failure
RyaliNvidia
had a problem deploying
to
internal-ci
GitHub Actions
Failure
RyaliNvidia
had a problem deploying
to
internal-ci
GitHub Actions
Failure
RyaliNvidia
had a problem deploying
to
internal-ci
GitHub Actions
Failure
RyaliNvidia
had a problem deploying
to
internal-ci
GitHub Actions
Failure
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
temporarily deployed
to
internal-ci
GitHub Actions
Inactive
RyaliNvidia
changed the title
elookpotts-nvidia
approved these changes
Nov 24, 2025
ecolternv
approved these changes
Nov 25, 2025
adelbertc
added a commit
that referenced
this pull request
Nov 26, 2025
…tiversion links (#93) * Add prerequisite for Git LFS to develop OSMO (#64) * Remove trigger response (#65) * Fix readme docs link (#68) * Enforce PR description in CI (#69) * Enforce PR description in CI * Add pull_request edit event * Move to its own file so checks don't run for every edit * formatting * add reopened event * Ethany/isaac lab examples (#66) * Update Isaac Sim Workflow * Add Isaac Lab Multi GPU/Node Samples * #71 - Add a root documentation page (#72) * #71 - Add a root documentation page * simplify subdir overrides * fix font * restore fallback fonts * fix deployment options card height * reorganize user guide landing * Make the SVG on the docs root page smaller (#74) * Adds multiversion support for docs (#40) * Use sphinx-multiversion so multiple versions of the docs are built --------- Co-authored-by: Fernando Luo <[email protected]> * docs: fix doc links after multiversion support (#76) * #78 - docs: temp fix for multiversion links (#80) * docs: fix broken user_guide multiversion links * Revert img src change Co-authored-by: RyaliNvidia <[email protected]> --------- Co-authored-by: RyaliNvidia <[email protected]> * quick-start: make apk fail fast (#84) apk add may fail due to things like transient upstream unavailability. Prior to this change we would get stuck in an infinite loop of trying to invoke curl. This change makes the simplest change to make it fail and let K8s handle restarting the init container. * Make docs root page use a grid (#85) * Make docs root page use a grid * remove main branch specifier * Remove unused file from root docs glob (#87) * Add ci-docs step to run bazel tests on docs/ changes (#88) * Add ci-docs step to run bazel tests on docs/ changes * only run build - not test * Resolve broken/redirect links in readme and documentation (#89) * #82 - Add link checking to documentation (#83) * Add link checking to documentation * Verified check * Fix artifacts upload * Resolve issue * update workflows logic * docs: unify sphinx build, fix multiversion links * 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. * fix hard-coded links * prepend main to some other hard-coded links * fix missing sidebar * cleanup multibuild state * fix sidebar toc by overriding nvidia-sphinx-theme * only linkcheck root now * add note in sidebar-nav-bs * restore custom index css to remove sidebar * fix broken images * fix multiversion build * add copyright * move usages from doc to ref --------- Co-authored-by: Ethan Look-Potts <[email protected]> Co-authored-by: Fernando L <[email protected]> Co-authored-by: RyaliNvidia <[email protected]> Co-authored-by: ethany-nv <[email protected]>
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
Use sphinx linkcheck to verify all the links in the documentation are valid
Also resolved an issues where build artifacts are not pushed if there is an error
Issue #82
Checklist