Skip to content

Commit 45db095

Browse files
[Backport] Update Visualization Docs (#7054) (#7555)
# Description Backports #7054 to `release/3.0.0`. The [automatic backport run](https://github.com/isaac-sim/IsaacLab/actions/runs/33827527258) selected the PR and completed the cherry-pick, but its exact-patch validator then failed because this source path was omitted as a no-op: `source/isaaclab_rl/changelog.d/maximiliank-skip-unsupported-checkpoint-presets.skip` That fragment is already present on `release/3.0.0` as the same empty blob (`e69de29bb2d1d6434b8b29ae775ad8c2e48c5391`). The repository's non-exact backport validation confirms that every other source path is preserved and reports this as the only `missing_paths_already_present` entry. No conflict resolution or manual source edits were required. | Field | Commit | |---|---| | Original merged change | `7cc829274ce6050dc8288f2ea93f2b5c2175dd38` | | Release base | `2af02510c` | | Backport commit | `1c599e23aa51f0ba81922d2c1af3cddbb07b4b09` | ## Type of change - Bug fix (non-breaking change which fixes an issue) - Documentation update ## Validation - Repository backport candidate validation passed; the only omitted source path is the already-identical empty `.skip` fragment described above. - Full changed-file pre-commit suite passed, including changelog and Git LFS checks. - `sphinx-lint` reported no problems for added and modified RST files. - Focused visualizer tests and the warning-as-error docs build are pending release CI because the repository lockfile does not support the local macOS/arm64 platform. ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the applicable pre-commit checks - [x] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings (full build pending Linux CI) - [ ] I have run the focused tests (pending Linux CI) - [x] Source changelog fragments are preserved - [x] The original contributor is already listed in `CONTRIBUTORS.md` Signed-off-by: matthewtrepte <mtrepte@nvidia.com> Signed-off-by: Kelly Guo <kellyg@nvidia.com> Co-authored-by: matthewtrepte <mtrepte@nvidia.com>
1 parent a6c727e commit 45db095

49 files changed

Lines changed: 4622 additions & 1768 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/check-links.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ jobs:
112112
--exclude 'andrew\.cmu\.edu/course/10-703/textbook/BartoSutton\.pdf'
113113
--exclude 'www\.nvidia\.com/en-us/security'
114114
--exclude 'bostondynamics\.com/reinforcement-learning-researcher-kit'
115+
--exclude 'opensource\.org'
115116
--exclude 'ros\.org'
116117
--max-retries 5
117118
--retry-wait-time 10

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ def _read_pinned_versions() -> dict:
328328
html_static_path = [
329329
"source/_static/css",
330330
"source/_static/how-to",
331+
"source/_static/visualizers",
331332
"source/_static/tasks/previews",
332333
"source/_static/benchmarks",
333334
]

docs/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ Table of Contents
102102
source/concepts/backends_and_presets
103103
source/concepts/actuators
104104
source/concepts/coupled_solvers
105+
source/concepts/scene_data_providers
106+
source/concepts/visualization
105107
source/concepts/reinforcement_learning
106108

107109

@@ -140,6 +142,9 @@ Table of Contents
140142
source/features/population_based_training
141143
source/features/ray
142144
source/features/reproducibility
145+
source/features/draw_markers
146+
source/features/record_video
147+
source/features/visualizer_tiled_camera
143148

144149

145150
.. toctree::

docs/source/_static/css/custom.css

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,3 +187,11 @@ figure.nurec-gif-contain img {
187187
button.copybtn {
188188
opacity: 1;
189189
}
190+
191+
/* Force readable code-block text in dark mode; some rendering paths were
192+
showing unstyled text in a dark color against the dark code background. */
193+
html[data-theme="dark"] pre,
194+
html[data-theme="dark"] .highlight,
195+
html[data-theme="dark"] .highlight pre {
196+
color: #ffffff !important;
197+
}
-141 KB
Binary file not shown.
Binary file not shown.
-205 KB
Binary file not shown.
Binary file not shown.
-274 KB
Binary file not shown.
135 KB
Loading

0 commit comments

Comments
 (0)