Updates github actions to error on doc warnings (#3488)

# Description

Some more infrastructure updates to brush up our automated jobs:

- treat warnings as errors in doc building and fixing some existing
warnings
- adding release branches to the doc versions
- making sure all jobs also get triggered on release branches
- fixes make script on windows
- fixes out of space error for license check job


## Type of change

- Documentation update


## 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 [`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
- [ ] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

---------

Co-authored-by: ooctipus <[email protected]>

Author: kellyguo11

.github/workflows/docs.yaml

@@ -10,6 +10,7 @@ on:
     branches:
       - main
       - devel
+      - 'release/**'
   pull_request:
     types: [opened, synchronize, reopened]
 
@@ -27,8 +28,7 @@ jobs:
     - id: trigger-deploy
       env:
         REPO_NAME: ${{ secrets.REPO_NAME }}
-        BRANCH_REF: ${{ secrets.BRANCH_REF }}
-      if: "${{ github.repository == env.REPO_NAME && github.ref == env.BRANCH_REF }}"
+      if: "${{ github.repository == env.REPO_NAME && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/devel' || startsWith(github.ref, 'refs/heads/release/')) }}"
       run: echo "defined=true" >> "$GITHUB_OUTPUT"
 
   build-docs:

.github/workflows/license-check.yaml

@@ -24,16 +24,20 @@ jobs:
     # - name: Install jq
     #   run: sudo apt-get update && sudo apt-get install -y jq
 
+    - name: Clean up disk space
+      run: |
+        rm -rf /opt/hostedtoolcache
+
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.10'  # Adjust as needed
+        python-version: '3.11'  # Adjust as needed
 
     - name: Install dependencies using ./isaaclab.sh -i
       run: |
         # first install isaac sim
         pip install --upgrade pip
-        pip install 'isaacsim[all,extscache]==4.5.0' --extra-index-url https://pypi.nvidia.com
+        pip install 'isaacsim[all,extscache]==${{ vars.ISAACSIM_BASE_VERSION || '5.0.0' }}' --extra-index-url https://pypi.nvidia.com
         chmod +x ./isaaclab.sh  # Make sure the script is executable
         # install all lab dependencies
         ./isaaclab.sh -i
@@ -48,6 +52,12 @@ jobs:
     - name: Print License Report
       run: pip-licenses --from=mixed --format=markdown
 
+    # Print pipdeptree
+    - name: Print pipdeptree
+      run: |
+        pip install pipdeptree
+        pipdeptree
+
     - name: Check licenses against whitelist and exceptions
       run: |
         # Define the whitelist of allowed licenses
@@ -118,9 +128,3 @@ jobs:
         else
           echo "All packages were checked."
         fi
-
-    # Print pipdeptree
-    - name: Print pipdeptree
-      run: |
-        pip install pipdeptree
-        pipdeptree

.github/workflows/license-exceptions.json

@@ -308,7 +308,7 @@
   },
   {
     "package": "typing_extensions",
-    "license": "UNKNOWN",
+    "license": "Python Software Foundation License",
     "comment": "PSFL / OSRB"
   },
   {
@@ -400,5 +400,30 @@
     "package": "fsspec",
     "license" : "UNKNOWN",
     "comment": "BSD"
+  },
+  {
+    "package": "numpy-quaternion",
+    "license": "UNKNOWN",
+    "comment": "MIT"
+  },
+  {
+    "package": "aiohappyeyeballs",
+    "license": "Other/Proprietary License; Python Software Foundation License",
+    "comment": "PSFL / OSRB"
+  },
+  {
+    "package": "cffi",
+    "license": "UNKNOWN",
+    "comment": "MIT"
+  },
+  {
+    "package": "trio",
+    "license": "UNKNOWN",
+    "comment": "MIT"
+  },
+  {
+    "package": "pipdeptree",
+    "license": "UNKNOWN",
+    "comment": "MIT"
   }
 ]

.github/workflows/pre-commit.yaml

@@ -7,8 +7,7 @@ name: Run linters using pre-commit
 
 on:
   pull_request:
-  push:
-    branches: [main]
+    types: [opened, synchronize, reopened]
 
 jobs:
   pre-commit:

docs/Makefile

@@ -15,4 +15,5 @@ multi-docs:
 
 .PHONY: current-docs
 current-docs:
-	@$(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)/current" $(SPHINXOPTS)
+	@rm -rf "$(BUILDDIR)/current"
+	@$(SPHINXBUILD) -W --keep-going "$(SOURCEDIR)" "$(BUILDDIR)/current" $(SPHINXOPTS)

docs/conf.py

@@ -282,7 +282,7 @@
 # Whitelist pattern for remotes
 smv_remote_whitelist = r"^.*$"
 # Whitelist pattern for branches (set to None to ignore all branches)
-smv_branch_whitelist = os.getenv("SMV_BRANCH_WHITELIST", r"^(main|devel)$")
+smv_branch_whitelist = os.getenv("SMV_BRANCH_WHITELIST", r"^(main|devel|release/.*)$")
 # Whitelist pattern for tags (set to None to ignore all tags)
 smv_tag_whitelist = os.getenv("SMV_TAG_WHITELIST", r"^v[1-9]\d*\.\d+\.\d+$")
 html_sidebars = {

docs/make.bat

@@ -13,8 +13,8 @@ if "%1" == "multi-docs" (
 	if "%SPHINXBUILD%" == "" (
 		set SPHINXBUILD=sphinx-multiversion
 	)
-	%SPHINXBUILD% >NUL 2>NUL
-	if errorlevel 9009 (
+	where %SPHINXBUILD% >NUL 2>NUL
+	if errorlevel 1 (
 		echo.
 		echo.The 'sphinx-multiversion' command was not found. Make sure you have Sphinx
 		echo.installed, then set the SPHINXBUILD environment variable to point
@@ -37,8 +37,8 @@ if "%1" == "current-docs" (
 	if "%SPHINXBUILD%" == "" (
 		set SPHINXBUILD=sphinx-build
 	)
-	%SPHINXBUILD% >NUL 2>NUL
-	if errorlevel 9009 (
+	where %SPHINXBUILD% >NUL 2>NUL
+	if errorlevel 1 (
 		echo.
 		echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
 		echo.installed, then set the SPHINXBUILD environment variable to point
@@ -49,7 +49,8 @@ if "%1" == "current-docs" (
 		echo.http://sphinx-doc.org/
 		exit /b 1
 	)
-	%SPHINXBUILD% %SOURCEDIR% %BUILDDIR%\current %SPHINXOPTS% %O%
+	if exist "%BUILDDIR%\current" rmdir /s /q "%BUILDDIR%\current"
+	%SPHINXBUILD% -W "%SOURCEDIR%" "%BUILDDIR%\current" %SPHINXOPTS%
 	goto end
 )
 

docs/source/api/lab/isaaclab.assets.rst

@@ -32,7 +32,7 @@ Asset Base
 
 .. autoclass:: AssetBaseCfg
     :members:
-    :exclude-members: __init__, class_type
+    :exclude-members: __init__, class_type, InitialStateCfg
 
 Rigid Object
 ------------

docs/source/api/lab/isaaclab.sensors.rst

@@ -61,7 +61,7 @@ USD Camera
     :members:
     :inherited-members:
     :show-inheritance:
-    :exclude-members: __init__, class_type
+    :exclude-members: __init__, class_type, OffsetCfg
 
 Tile-Rendered USD Camera
 ------------------------