[misc] Update documentation.

duburcqa · Nov 29, 2024 · 2cfc7cb · 2cfc7cb
1 parent 370faaa
commit 2cfc7cb
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 10 deletions.
diff --git a/docs/api/gym_jiminy/common/wrappers/index.rst b/docs/api/gym_jiminy/common/wrappers/index.rst
@@ -5,6 +5,6 @@ Wrappers
    :maxdepth: 1
 
    flatten
-   normalize
-   observation_filter
+   scale
+   observation_layout
    observation_stack
diff --git a/docs/api/gym_jiminy/common/wrappers/normalize.rst b/docs/api/gym_jiminy/common/wrappers/normalize.rst
diff --git a/...ny/common/wrappers/observation_filter.rst → ...ny/common/wrappers/observation_layout.rst b/...ny/common/wrappers/observation_filter.rst → ...ny/common/wrappers/observation_layout.rst
@@ -1,5 +1,5 @@
-Observation Filtering
-=====================
+Observation Layout Adaptation
+=============================
 
 .. automodule:: gym_jiminy.common.wrappers.observation_filter
    :members:

diff --git a/docs/api/gym_jiminy/common/wrappers/scale.rst b/docs/api/gym_jiminy/common/wrappers/scale.rst
@@ -0,0 +1,10 @@
+Scaling and normalization
+=========================
+
+.. automodule:: gym_jiminy.common.wrappers.scale
+   :members:
+   :show-inheritance:
+
+.. automodule:: gym_jiminy.common.wrappers.normalize
+   :members:
+   :show-inheritance: