From 64047009c6ab43e53d5caeea9afe7a50dd9cf77a Mon Sep 17 00:00:00 2001 From: Andrea Ostuni Date: Sat, 3 Feb 2024 12:49:22 +0100 Subject: [PATCH] fixes on documentation refactor --- .github/workflows/cicd.yml | 4 +- .../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 ----- docs/sphinx/conf.py | 8 ++- docs/sphinx/info/limitations.rst | 2 +- docs/sphinx/installation/support_policy.rst | 4 +- .../why/{why_gz_gazebo.rst => why_gz_sim.rst} | 0 23 files changed, 11 insertions(+), 480 deletions(-) delete mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.models.rst delete mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.randomizers.rst delete mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.rst delete mode 100644 docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.tasks.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.base.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.context.gazebo.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.context.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.model.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.physics.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.rbd.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.runtimes.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.scenario.rst delete mode 100644 docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst delete mode 100644 docs/sphinx/apidoc/scenario/scenario.bindings.rst delete mode 100644 docs/sphinx/apidoc/scenario/scenario.rst rename docs/sphinx/why/{why_gz_gazebo.rst => why_gz_sim.rst} (100%) diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml index 37862947f..e121d204e 100644 --- a/.github/workflows/cicd.yml +++ b/.github/workflows/cicd.yml @@ -352,8 +352,10 @@ jobs: - name: '📝 Rename scenario wheel' if: matrix.type == 'User' && contains(matrix.os, 'ubuntu') run: | + sudo apt update + sudo apt install rename ls dist/ - find dist/ -type f -name "*.whl" -exec rename.ul linux manylinux2014 {} + + find dist/ -type f -name "*.whl" -exec rename "s/linux/manylinux2014/g" {} + ls dist/ - name: '🔍 Inspect dist folder' 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 deleted file mode 100644 index 2f73ac88e..000000000 --- a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.models.rst +++ /dev/null @@ -1,40 +0,0 @@ -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 deleted file mode 100644 index 027e9fd76..000000000 --- a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.randomizers.rst +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index fe617da77..000000000 --- a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.rst +++ /dev/null @@ -1,15 +0,0 @@ -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 deleted file mode 100644 index f49d2df01..000000000 --- a/docs/sphinx/apidoc/gym-gz-environments/gym_gz_environments.tasks.rst +++ /dev/null @@ -1,40 +0,0 @@ -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 deleted file mode 100644 index 9507f9f5d..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.base.rst +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index f99cba328..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.context.gazebo.rst +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index 6a7e5922c..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.context.rst +++ /dev/null @@ -1,13 +0,0 @@ -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 deleted file mode 100644 index 4b1371ff2..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.model.rst +++ /dev/null @@ -1,16 +0,0 @@ -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 deleted file mode 100644 index 265cb6fb8..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.physics.rst +++ /dev/null @@ -1,16 +0,0 @@ -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 deleted file mode 100644 index 53776955d..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.randomizers.rst +++ /dev/null @@ -1,31 +0,0 @@ -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 deleted file mode 100644 index 5cb1e89ca..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst +++ /dev/null @@ -1,40 +0,0 @@ -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 deleted file mode 100644 index a3e5ac112..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.rbd.rst +++ /dev/null @@ -1,30 +0,0 @@ -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 deleted file mode 100644 index 8ee4bc049..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.rst +++ /dev/null @@ -1,19 +0,0 @@ -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 deleted file mode 100644 index 2ee6501a0..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.runtimes.rst +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index 89a997f3a..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.scenario.rst +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index 0411924d8..000000000 --- a/docs/sphinx/apidoc/gym-gz/gym_gz.utils.rst +++ /dev/null @@ -1,56 +0,0 @@ -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 deleted file mode 100644 index dfdf538a2..000000000 --- a/docs/sphinx/apidoc/scenario/scenario.bindings.rst +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index 7ee5426d4..000000000 --- a/docs/sphinx/apidoc/scenario/scenario.rst +++ /dev/null @@ -1,13 +0,0 @@ -scenario -======== - -.. automodule:: scenario - :members: - :undoc-members: - :show-inheritance: - - -.. toctree:: - :maxdepth: 4 - - scenario.bindings diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 30f5ddc6f..35d33bc46 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -32,7 +32,7 @@ "sphinx.ext.mathjax", "sphinx.ext.githubpages", "sphinx.ext.napoleon", - # "sphinx.ext.extlinks", + "sphinx.ext.extlinks", "sphinx_autodoc_typehints", "sphinx_multiversion", "sphinx_fontawesome", @@ -121,6 +121,8 @@ # -- Options for extlinks extension ---------------------------------- extlinks = { - "issue": ("https://github.com/andreaostuni/gym-gz/issues/%s", "#"), - "pr": ("https://github.com/andreaostuni/gym-gz/pull/%s", "#"), + "old_issue": ("https://github.com/andreaostuni/gym-ignition/issues/%s", "#%s"), + "old_pr": ("https://github.com/robotology/gym-ignition/pull/%s", "#%s"), + "issue": ("https://github.com/andreaostuni/gym-gz/issues/%s", "#%s"), + "pr": ("https://github.com/andreaostuni/gym-gz/pull/%s", "#%s"), } diff --git a/docs/sphinx/info/limitations.rst b/docs/sphinx/info/limitations.rst index c5c4e2ab0..80f4270e4 100644 --- a/docs/sphinx/info/limitations.rst +++ b/docs/sphinx/info/limitations.rst @@ -7,7 +7,7 @@ Sensors support Gz sim supports a wide variety of `sensors `_, like cameras, lidars, ... However, ScenarI/O and consequently gym-gz are not yet able to extract data from sensors. -Follow :issue:`199` if you're interested in sensors support. +Follow :old_issue:`199` if you're interested in sensors support. Performance ----------- diff --git a/docs/sphinx/installation/support_policy.rst b/docs/sphinx/installation/support_policy.rst index ef635eb7d..ad212ec24 100644 --- a/docs/sphinx/installation/support_policy.rst +++ b/docs/sphinx/installation/support_policy.rst @@ -13,7 +13,7 @@ We do not yet provide official support to other operating systems. The table below recaps the project requirements of the :ref:`Stable ` and :ref:`Nightly ` channels: +-------------+-----------------+--------+----------------------+----------+------------+---------+ -| Channel | C++ | Python | Gz | Ubuntu | macOS [*]_ | Windows | +| Channel | C++ | Python | Gz | Ubuntu | macOS [*]_ | Windows | +=============+=================+========+======================+==========+============+=========+ | **Stable** | >= gcc8, clang6 | >= 3.8 | `Fortress`_ (binary) | >= 20.04 | No | No | +-------------+-----------------+--------+----------------------+----------+------------+---------+ @@ -39,4 +39,4 @@ The table below recaps the project requirements of the :ref:`Stable `_, we have our own :issue:`1`. + In the same spirit of `ubuntu/+bug/1 `_, we have our own :old_issue:`1`. diff --git a/docs/sphinx/why/why_gz_gazebo.rst b/docs/sphinx/why/why_gz_sim.rst similarity index 100% rename from docs/sphinx/why/why_gz_gazebo.rst rename to docs/sphinx/why/why_gz_sim.rst