new apidoc

andreaostuni · Feb 3, 2024 · 49139b1 · 49139b1
1 parent 6404700
commit 49139b1
Show file tree

Hide file tree

Showing 18 changed files with 473 additions and 0 deletions.
diff --git a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.models.rst b/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.models.rst
@@ -0,0 +1,40 @@
+gym\_gz\_environments.models
+============================
+
+.. automodule:: gym_gz_environments.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz\_environments.models.cartpole
+-------------------------------------
+
+.. automodule:: gym_gz_environments.models.cartpole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.models.icub
+---------------------------------
+
+.. automodule:: gym_gz_environments.models.icub
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.models.panda
+----------------------------------
+
+.. automodule:: gym_gz_environments.models.panda
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.models.pendulum
+-------------------------------------
+
+.. automodule:: gym_gz_environments.models.pendulum
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.randomizers.rst b/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.randomizers.rst
@@ -0,0 +1,24 @@
+gym\_gz\_environments.randomizers
+=================================
+
+.. automodule:: gym_gz_environments.randomizers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz\_environments.randomizers.cartpole
+------------------------------------------
+
+.. automodule:: gym_gz_environments.randomizers.cartpole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.randomizers.cartpole\_no\_rand
+----------------------------------------------------
+
+.. automodule:: gym_gz_environments.randomizers.cartpole_no_rand
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.rst b/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.rst
@@ -0,0 +1,15 @@
+gym\_gz\_environments
+=====================
+
+.. automodule:: gym_gz_environments
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 4
+
+   gym_gz_environments.models
+   gym_gz_environments.randomizers
+   gym_gz_environments.tasks
diff --git a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.tasks.rst b/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.tasks.rst
@@ -0,0 +1,40 @@
+gym\_gz\_environments.tasks
+===========================
+
+.. automodule:: gym_gz_environments.tasks
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz\_environments.tasks.cartpole\_continuous\_balancing
+-----------------------------------------------------------
+
+.. automodule:: gym_gz_environments.tasks.cartpole_continuous_balancing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.tasks.cartpole\_continuous\_swingup
+---------------------------------------------------------
+
+.. automodule:: gym_gz_environments.tasks.cartpole_continuous_swingup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.tasks.cartpole\_discrete\_balancing
+---------------------------------------------------------
+
+.. automodule:: gym_gz_environments.tasks.cartpole_discrete_balancing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz\_environments.tasks.pendulum\_swingup
+---------------------------------------------
+
+.. automodule:: gym_gz_environments.tasks.pendulum_swingup
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.base.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.base.rst
@@ -0,0 +1,24 @@
+gym\_gz.base
+============
+
+.. automodule:: gym_gz.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.base.runtime
+--------------------
+
+.. automodule:: gym_gz.base.runtime
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.base.task
+-----------------
+
+.. automodule:: gym_gz.base.task
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.context.gazebo.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.context.gazebo.rst
@@ -0,0 +1,24 @@
+gym\_gz.context.gazebo
+======================
+
+.. automodule:: gym_gz.context.gazebo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.context.gazebo.controllers
+----------------------------------
+
+.. automodule:: gym_gz.context.gazebo.controllers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.context.gazebo.plugin
+-----------------------------
+
+.. automodule:: gym_gz.context.gazebo.plugin
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.context.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.context.rst
@@ -0,0 +1,13 @@
+gym\_gz.context
+===============
+
+.. automodule:: gym_gz.context
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 4
+
+   gym_gz.context.gazebo
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.model.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.model.rst
@@ -0,0 +1,16 @@
+gym\_gz.randomizers.model
+=========================
+
+.. automodule:: gym_gz.randomizers.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.randomizers.model.sdf
+-----------------------------
+
+.. automodule:: gym_gz.randomizers.model.sdf
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.physics.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.physics.rst
@@ -0,0 +1,16 @@
+gym\_gz.randomizers.physics
+===========================
+
+.. automodule:: gym_gz.randomizers.physics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.randomizers.physics.dart
+--------------------------------
+
+.. automodule:: gym_gz.randomizers.physics.dart
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.rst
@@ -0,0 +1,31 @@
+gym\_gz.randomizers
+===================
+
+.. automodule:: gym_gz.randomizers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 4
+
+   gym_gz.randomizers.model
+   gym_gz.randomizers.physics
+
+
+gym\_gz.randomizers.abc
+-----------------------
+
+.. automodule:: gym_gz.randomizers.abc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.randomizers.gazebo\_env\_randomizer
+-------------------------------------------
+
+.. automodule:: gym_gz.randomizers.gazebo_env_randomizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst
@@ -0,0 +1,40 @@
+gym\_gz.rbd.idyntree
+====================
+
+.. automodule:: gym_gz.rbd.idyntree
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.rbd.idyntree.helpers
+----------------------------
+
+.. automodule:: gym_gz.rbd.idyntree.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.rbd.idyntree.inverse\_kinematics\_nlp
+---------------------------------------------
+
+.. automodule:: gym_gz.rbd.idyntree.inverse_kinematics_nlp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.rbd.idyntree.kindyncomputations
+---------------------------------------
+
+.. automodule:: gym_gz.rbd.idyntree.kindyncomputations
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.rbd.idyntree.numpy
+--------------------------
+
+.. automodule:: gym_gz.rbd.idyntree.numpy
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.rbd.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.rbd.rst
@@ -0,0 +1,30 @@
+gym\_gz.rbd
+===========
+
+.. automodule:: gym_gz.rbd
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 4
+
+   gym_gz.rbd.idyntree
+
+
+gym\_gz.rbd.conversions
+-----------------------
+
+.. automodule:: gym_gz.rbd.conversions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.rbd.utils
+-----------------
+
+.. automodule:: gym_gz.rbd.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.rst
@@ -0,0 +1,19 @@
+gym\_gz
+=======
+
+.. automodule:: gym_gz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 4
+
+   gym_gz.base
+   gym_gz.context
+   gym_gz.randomizers
+   gym_gz.rbd
+   gym_gz.runtimes
+   gym_gz.scenario
+   gym_gz.utils
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.runtimes.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.runtimes.rst
@@ -0,0 +1,24 @@
+gym\_gz.runtimes
+================
+
+.. automodule:: gym_gz.runtimes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.runtimes.gazebo\_runtime
+--------------------------------
+
+.. automodule:: gym_gz.runtimes.gazebo_runtime
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.runtimes.realtime\_runtime
+----------------------------------
+
+.. automodule:: gym_gz.runtimes.realtime_runtime
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.scenario.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.scenario.rst
@@ -0,0 +1,24 @@
+gym\_gz.scenario
+================
+
+.. automodule:: gym_gz.scenario
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+gym\_gz.scenario.model\_with\_file
+----------------------------------
+
+.. automodule:: gym_gz.scenario.model_with_file
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gym\_gz.scenario.model\_wrapper
+-------------------------------
+
+.. automodule:: gym_gz.scenario.model_wrapper
+   :members:
+   :undoc-members:
+   :show-inheritance: