From 49139b1f73ae2d1e7f082719f391d38cc8130f46 Mon Sep 17 00:00:00 2001 From: Andrea Ostuni Date: Sat, 3 Feb 2024 12:56:25 +0100 Subject: [PATCH] new apidoc --- .../gym_gz_environments.models.rst | 40 +++++++++++++ .../gym_gz_environments.randomizers.rst | 24 ++++++++ .../gym_gz_environments.rst | 15 +++++ .../gym_gz_environments.tasks.rst | 40 +++++++++++++ docs/sphinx/apidoc/gym-gz/gym_gz.base.rst | 24 ++++++++ .../apidoc/gym-gz/gym_gz.context.gazebo.rst | 24 ++++++++ docs/sphinx/apidoc/gym-gz/gym_gz.context.rst | 13 +++++ .../gym-gz/gym_gz.randomizers.model.rst | 16 ++++++ .../gym-gz/gym_gz.randomizers.physics.rst | 16 ++++++ .../apidoc/gym-gz/gym_gz.randomizers.rst | 31 ++++++++++ .../apidoc/gym-gz/gym_gz.rbd.idyntree.rst | 40 +++++++++++++ docs/sphinx/apidoc/gym-gz/gym_gz.rbd.rst | 30 ++++++++++ docs/sphinx/apidoc/gym-gz/gym_gz.rst | 19 +++++++ docs/sphinx/apidoc/gym-gz/gym_gz.runtimes.rst | 24 ++++++++ docs/sphinx/apidoc/gym-gz/gym_gz.scenario.rst | 24 ++++++++ docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst | 56 +++++++++++++++++++ .../apidoc/scenario/scenario.bindings.rst | 24 ++++++++ docs/sphinx/apidoc/scenario/scenario.rst | 13 +++++ 18 files changed, 473 insertions(+) create mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.models.rst create mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.randomizers.rst create mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.rst create mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.tasks.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.base.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.context.gazebo.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.context.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.model.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.physics.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.rbd.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.runtimes.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.scenario.rst create mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst create mode 100644 docs/sphinx/apidoc/scenario/scenario.bindings.rst create mode 100644 docs/sphinx/apidoc/scenario/scenario.rst 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 new file mode 100644 index 000000000..2f73ac88e --- /dev/null +++ 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 new file mode 100644 index 000000000..027e9fd76 --- /dev/null +++ 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 new file mode 100644 index 000000000..fe617da77 --- /dev/null +++ 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 new file mode 100644 index 000000000..f49d2df01 --- /dev/null +++ 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 new file mode 100644 index 000000000..9507f9f5d --- /dev/null +++ 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 new file mode 100644 index 000000000..f99cba328 --- /dev/null +++ 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 new file mode 100644 index 000000000..6a7e5922c --- /dev/null +++ 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 new file mode 100644 index 000000000..4b1371ff2 --- /dev/null +++ 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 new file mode 100644 index 000000000..265cb6fb8 --- /dev/null +++ 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 new file mode 100644 index 000000000..53776955d --- /dev/null +++ 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 new file mode 100644 index 000000000..5cb1e89ca --- /dev/null +++ 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 new file mode 100644 index 000000000..a3e5ac112 --- /dev/null +++ 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 new file mode 100644 index 000000000..8ee4bc049 --- /dev/null +++ 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 new file mode 100644 index 000000000..2ee6501a0 --- /dev/null +++ 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 new file mode 100644 index 000000000..89a997f3a --- /dev/null +++ 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: diff --git a/docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst b/docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst new file mode 100644 index 000000000..0411924d8 --- /dev/null +++ b/docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst @@ -0,0 +1,56 @@ +gym\_gz.utils +============= + +.. automodule:: gym_gz.utils + :members: + :undoc-members: + :show-inheritance: + + +gym\_gz.utils.logger +-------------------- + +.. automodule:: gym_gz.utils.logger + :members: + :undoc-members: + :show-inheritance: + +gym\_gz.utils.math +------------------ + +.. automodule:: gym_gz.utils.math + :members: + :undoc-members: + :show-inheritance: + +gym\_gz.utils.misc +------------------ + +.. automodule:: gym_gz.utils.misc + :members: + :undoc-members: + :show-inheritance: + +gym\_gz.utils.resource\_finder +------------------------------ + +.. automodule:: gym_gz.utils.resource_finder + :members: + :undoc-members: + :show-inheritance: + +gym\_gz.utils.scenario +---------------------- + +.. automodule:: gym_gz.utils.scenario + :members: + :undoc-members: + :show-inheritance: + +gym\_gz.utils.typing +-------------------- + +.. automodule:: gym_gz.utils.typing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/apidoc/scenario/scenario.bindings.rst b/docs/sphinx/apidoc/scenario/scenario.bindings.rst new file mode 100644 index 000000000..dfdf538a2 --- /dev/null +++ b/docs/sphinx/apidoc/scenario/scenario.bindings.rst @@ -0,0 +1,24 @@ +scenario.bindings +================= + +.. automodule:: scenario.bindings + :members: + :undoc-members: + :show-inheritance: + + +scenario.bindings.core +---------------------- + +.. automodule:: scenario.bindings.core + :members: + :undoc-members: + :show-inheritance: + +scenario.bindings.gazebo +------------------------ + +.. automodule:: scenario.bindings.gazebo + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/apidoc/scenario/scenario.rst b/docs/sphinx/apidoc/scenario/scenario.rst new file mode 100644 index 000000000..7ee5426d4 --- /dev/null +++ b/docs/sphinx/apidoc/scenario/scenario.rst @@ -0,0 +1,13 @@ +scenario +======== + +.. automodule:: scenario + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 4 + + scenario.bindings