Fixes IsaacLab Mimic doc build warnings (#3065)

peterd-NV · kellyguo11 · commit 60b67ff08669 · 2025-08-05T16:05:34.000-07:00
Fixes warnings when building docs for IsaacLab Mimic by using `from __future__ import annotations` to allow Sphinx autodoc import. - Bug fix (non-breaking change which fixes an issue) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there
diff --git a/source/isaaclab/config/extension.toml b/source/isaaclab/config/extension.toml
@@ -1,7 +1,7 @@
 [package]
 
 # Note: Semantic Versioning is used: https://semver.org/
-version = "0.44.8"
+version = "0.44.9"
 
 # Description
 title = "Isaac Lab framework for Robot Learning"
diff --git a/source/isaaclab/docs/CHANGELOG.rst b/source/isaaclab/docs/CHANGELOG.rst
@@ -1,6 +1,16 @@
 Changelog
 ---------
 
+0.44.9 (2025-07-30)
+~~~~~~~~~~~~~~~~~~~
+
+Added
+^^^^^
+
+* Added ``from __future__ import annotations`` to manager_based_rl_mimic_env.py to fix Sphinx
+  doc warnings for IsaacLab Mimic docs.
+
+
 0.44.8 (2025-07-30)
 ~~~~~~~~~~~~~~~~~~~
 
diff --git a/source/isaaclab/isaaclab/envs/manager_based_rl_mimic_env.py b/source/isaaclab/isaaclab/envs/manager_based_rl_mimic_env.py
@@ -2,6 +2,8 @@
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
+from __future__ import annotations
+
 import torch
 from collections.abc import Sequence
 
diff --git a/source/isaaclab_mimic/config/extension.toml b/source/isaaclab_mimic/config/extension.toml
@@ -1,7 +1,7 @@
 [package]
 
 # Semantic Versioning is used: https://semver.org/
-version = "1.0.11"
+version = "1.0.12"
 
 # Description
 category = "isaaclab"
diff --git a/source/isaaclab_mimic/docs/CHANGELOG.rst b/source/isaaclab_mimic/docs/CHANGELOG.rst
@@ -1,8 +1,18 @@
 Changelog
 ---------
 
+1.0.12 (2025-07-31)
+~~~~~~~~~~~~~~~~~~~
+
+Added
+^^^^^
+
+* Added ``from __future__ import annotations`` to utils.py to fix Sphinx
+  doc warnings for IsaacLab Mimic docs.
+
+
 1.0.11 (2025-07-17)
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 
 Changed
 ^^^^^^^
@@ -12,7 +22,7 @@ Changed
 
 
 1.0.10 (2025-07-08)
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 
 Changed
 ^^^^^^^
diff --git a/source/isaaclab_mimic/isaaclab_mimic/datagen/utils.py b/source/isaaclab_mimic/isaaclab_mimic/datagen/utils.py
@@ -2,6 +2,7 @@
 # All rights reserved.
 #
 # SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
 
 import os
 from collections.abc import Callable
diff --git a/source/isaaclab_tasks/config/extension.toml b/source/isaaclab_tasks/config/extension.toml
@@ -1,7 +1,7 @@
 [package]
 
 # Note: Semantic Versioning is used: https://semver.org/
-version = "0.10.44"
+version = "0.10.45"
 
 # Description
 title = "Isaac Lab Environments"
diff --git a/source/isaaclab_tasks/docs/CHANGELOG.rst b/source/isaaclab_tasks/docs/CHANGELOG.rst
@@ -1,6 +1,16 @@
 Changelog
 ---------
 
+0.10.45 (2025-07-16)
+~~~~~~~~~~~~~~~~~~~~
+
+Added
+^^^^^
+
+* Added ``from __future__ import annotations`` to isaaclab_tasks files to fix Sphinx
+  doc warnings for IsaacLab Mimic docs.
+
+
 0.10.44 (2025-07-16)
 ~~~~~~~~~~~~~~~~~~~~
 
diff --git a/source/isaaclab_tasks/isaaclab_tasks/direct/forge/forge_events.py b/source/isaaclab_tasks/isaaclab_tasks/direct/forge/forge_events.py
@@ -2,6 +2,7 @@
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
+from __future__ import annotations
 
 import torch
 
diff --git a/source/isaaclab_tasks/isaaclab_tasks/direct/humanoid_amp/motions/motion_viewer.py b/source/isaaclab_tasks/isaaclab_tasks/direct/humanoid_amp/motions/motion_viewer.py
@@ -2,6 +2,7 @@
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
+from __future__ import annotations
 
 import matplotlib
 import matplotlib.animation

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`# All rights reserved.`
`3`	`3`	`#`
`4`	`4`	`# SPDX-License-Identifier: BSD-3-Clause`
	`5`	`+from __future__ import annotations`
	`6`	`+`
`5`	`7`	`import torch`
`6`	`8`	`from collections.abc import Sequence`
`7`	`9`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`# All rights reserved.`
`3`	`3`	`#`
`4`	`4`	`# SPDX-License-Identifier: Apache-2.0`
	`5`	`+from __future__ import annotations`
`5`	`6`
`6`	`7`	`import os`
`7`	`8`	`from collections.abc import Callable`