Adds icons for OS to documentation tabs

docs/conf.py

@@ -51,6 +51,7 @@ extensions = [
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinxcontrib.bibtex",
+    "sphinxcontrib.icon",
     "sphinx_copybutton",
     "sphinx_design",
 ]

docs/requirements.txt

 # for building the docs
-sphinx-book-theme==1.1.3
+sphinx-book-theme==1.0.1
 myst-parser
-sphinxcontrib-bibtex
+sphinxcontrib-bibtex==2.5.0
 autodocsumm
 sphinx-copybutton
+sphinx-icon
 sphinx_design
 sphinxemoji
 

docs/source/_static/css/custom.css

@@ -25,6 +25,7 @@ html[data-theme="light"] {
     --pst-color-on-surface: #e1e1e1;
     --pst-color-link: var(--pst-color-primary);
     --pst-color-link-hover: #789841;
+    --pst-color-table-row-hover-bg: #daedb9;
 }
 
 /* anything related to the dark theme */
@@ -33,8 +34,8 @@ html[data-theme="dark"] {
     --pst-color-secondary: #c2f26f;
     --pst-color-secondary-highlight: #c2f26f;
     --pst-color-inline-code-links: #b6e664;
-    --pst-color-info: #76B900;
-    --pst-color-info-highlight: #76B900;
+    --pst-color-info: var(--pst-color-primary);
+    --pst-color-info-highlight: var(--pst-color-primary);
     --pst-color-info-bg: #3a550b;
     --pst-color-attention: #dca90f;
     --pst-color-text-base: #cecece;
@@ -49,6 +50,7 @@ html[data-theme="dark"] {
     --pst-color-on-surface: #373737;
     --pst-color-link: var(--pst-color-primary);
     --pst-color-link-hover: #aee354;
+    --pst-color-table-row-hover-bg: #3a550b;
 }
 
 a {

docs/source/setup/installation/binaries_installation.rst

@@ -22,13 +22,13 @@ To check the minimum system requirements,refer to the documentation
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          On Linux systems, by default, Isaac Sim is installed in the directory
          ``${HOME}/.local/share/ov/pkg/isaac_sim-*``, with ``*`` corresponding to the Isaac Sim version.
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          On Windows systems, by default,Isaac Sim is installed in the directory
@@ -72,7 +72,7 @@ Clone the Isaac Lab repository into your workspace:
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          .. code:: text
@@ -93,7 +93,7 @@ Clone the Isaac Lab repository into your workspace:
                -d, --docs           Build the documentation from source using sphinx.
                -c, --conda [NAME]   Create the conda environment for Isaac Lab. Default name is 'isaaclab'.
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          .. code:: text
@@ -124,7 +124,7 @@ to index the python modules and look for extensions shipped with Isaac Sim.
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code:: bash
@@ -135,7 +135,7 @@ to index the python modules and look for extensions shipped with Isaac Sim.
          ln -s path_to_isaac_sim _isaac_sim
          # For example: ln -s /home/nvidia/.local/share/ov/pkg/isaac-sim-4.0.0 _isaac_sim
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code:: batch
@@ -167,7 +167,7 @@ use the following command:
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code:: bash
@@ -177,7 +177,7 @@ use the following command:
          # Option 2: Custom name for conda environment
          ./isaaclab.sh --conda my_env  # or "./isaaclab.sh -c my_env"
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code:: batch
@@ -218,14 +218,14 @@ Installation
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code:: bash
 
          ./isaaclab.sh --install # or "./isaaclab.sh -i"
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code:: batch
@@ -240,14 +240,14 @@ Installation
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          .. code:: bash
 
             ./isaaclab.sh --install rl_games  # or "./isaaclab.sh -i rl_games"
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          .. code:: batch

docs/source/setup/installation/cloud_installation.rst

@@ -54,14 +54,14 @@ To run Isaac Automator, first build the Isaac Automator container:
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code-block:: bash
 
          ./build
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code-block:: batch
@@ -73,14 +73,14 @@ Next, enter the automator container:
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code-block:: bash
 
          ./run
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code-block:: batch
@@ -121,14 +121,14 @@ For example:
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code-block:: bash
 
          ./isaaclab.sh -p source/standalone/workflows/rl_games/train.py --task=Isaac-Cartpole-v0
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code-block:: batch

docs/source/setup/installation/pip_installation.rst

@@ -35,7 +35,7 @@ Installing Isaac Sim
          .. tab-set::
             :sync-group: os
 
-            .. tab-item:: Linux
+            .. tab-item:: :icon:`fa-brands fa-linux` Linux
                :sync: linux
 
                .. code-block:: bash
@@ -45,7 +45,7 @@ Installing Isaac Sim
                   # activate the conda environment
                   source isaaclab/bin/activate
 
-            .. tab-item:: Windows
+            .. tab-item:: :icon:`fa-brands fa-windows` Windows
                :sync: windows
 
                .. code-block:: batch
@@ -117,7 +117,7 @@ Clone the Isaac Lab repository into your workspace:
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          .. code:: text
@@ -138,7 +138,7 @@ Clone the Isaac Lab repository into your workspace:
                -d, --docs           Build the documentation from source using sphinx.
                -c, --conda [NAME]   Create the conda environment for Isaac Lab. Default name is 'isaaclab'.
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          .. code:: text
@@ -173,14 +173,14 @@ Installation
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code:: bash
 
          ./isaaclab.sh --install # or "./isaaclab.sh -i"
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code:: bash
@@ -195,14 +195,14 @@ Installation
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          .. code:: bash
 
             ./isaaclab.sh --install rl_games  # or "./isaaclab.sh -i rl_games"
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          .. code:: bash

docs/source/setup/installation/verifying_installation.rst

@@ -63,7 +63,7 @@ variables to your terminal for the remaining of the installation instructions:
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code:: bash
@@ -73,7 +73,7 @@ variables to your terminal for the remaining of the installation instructions:
          # Isaac Sim python executable
          export ISAACSIM_PYTHON_EXE="${ISAACSIM_PATH}/python.sh"
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code:: batch
@@ -93,7 +93,7 @@ For more information on common paths, please check the Isaac Sim
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          .. code:: bash
@@ -101,7 +101,7 @@ For more information on common paths, please check the Isaac Sim
             # note: you can pass the argument "--help" to see all arguments possible.
             ${ISAACSIM_PATH}/isaac-sim.sh
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          .. code:: batch
@@ -115,7 +115,7 @@ For more information on common paths, please check the Isaac Sim
    .. tab-set::
       :sync-group: os
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
          :sync: linux
 
          .. code:: bash
@@ -125,7 +125,7 @@ For more information on common paths, please check the Isaac Sim
             # checks that Isaac Sim can be launched from python
             ${ISAACSIM_PYTHON_EXE} ${ISAACSIM_PATH}/standalone_examples/api/omni.isaac.core/add_cubes.py
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
          :sync: windows
 
          .. code:: batch
@@ -143,13 +143,13 @@ For more information on common paths, please check the Isaac Sim
 
    .. tab-set::
 
-      .. tab-item:: Linux
+      .. tab-item:: :icon:`fa-brands fa-linux` Linux
 
       	.. code:: bash
 
       		${ISAACSIM_PATH}/isaac-sim.sh --reset-user
 
-      .. tab-item:: Windows
+      .. tab-item:: :icon:`fa-brands fa-windows` Windows
 
          .. code:: batch
 
@@ -173,7 +173,7 @@ top of the repository:
 .. tab-set::
    :sync-group: os
 
-   .. tab-item:: Linux
+   .. tab-item:: :icon:`fa-brands fa-linux` Linux
       :sync: linux
 
       .. code:: bash
@@ -185,7 +185,7 @@ top of the repository:
          # Option 2: Using python in your virtual environment
          python source/standalone/tutorials/00_sim/create_empty.py
 
-   .. tab-item:: Windows
+   .. tab-item:: :icon:`fa-brands fa-windows` Windows
       :sync: windows
 
       .. code:: batch

source/extensions/omni.isaac.lab/omni/isaac/lab/sensors/camera/tiled_camera.py

@@ -39,16 +39,16 @@ class TiledCamera(Camera):
     - ``"rgb"``: A rendered color image.
     - ``"depth"``: An image containing the distance to camera optical center.
 
-    .. versionadded:: Isaac Sim 4.0
-
-        This feature is available starting from Isaac Sim 4.0. Before this version, the tiled rendering APIs
-        were not available.
-
     .. attention::
         Please note that the fidelity of RGB images may be lower than the standard camera sensor due to the
         tiled rendering process. Various ray tracing effects such as reflections, refractions, and shadows may not be
         accurately captured in the RGB images. We are currently working on improving the fidelity of the RGB images.
 
+    .. versionadded:: v1.0.0
+
+        This feature is available starting from Isaac Sim 4.0. Before this version, the tiled rendering APIs
+        were not available.
+
     """
 
     cfg: TiledCameraCfg

source/extensions/omni.isaac.lab/omni/isaac/lab/utils/buffers/delay_buffer.py

@@ -84,7 +84,7 @@ class DelayBuffer:
 
     @property
     def max_time_lag(self) -> int:
-        """Maximum number of time steps that can be delayed.
+        """Maximum amount of time steps that can be delayed.
 
         This value cannot be greater than :attr:`history_length`.
         """