Skip to content

Commit

Permalink
docs: update external links (#292)
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa authored Aug 15, 2023
1 parent 1e5b2b0 commit 81154d8
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@
# -- External links dictionary -----------------------------------------------
# Here you will find some often used global url definitions.
extlinks = {
"stable_gym": ("https://github.com/rickstaa/stable-gym/%s", None),
"stable-gym": ("https://github.com/rickstaa/stable-gym/%s", None),
"gymnasium": ("https://gymnasium.farama.org/%s", None),
"gymnasium-robotics": ("https://robotics.farama.org/%s", None),
"PyFlyt": ("https://jjshoots.github.io/PyFlyt/documentation%s", None),
"stable_learning_control": (
"https://github.com/rickstaa/stable-learning-control/%s",
None,
),
"ros_gazebo_gym": ("https://github.com/rickstaa/ros-gazebo-gym/%s", None),
"ros-gazebo-gym": ("https://github.com/rickstaa/ros-gazebo-gym/%s", None),
"pybullet": ("https://pybullet.org/%s", None),
}

Expand Down
2 changes: 1 addition & 1 deletion docs/source/dev/add_new_envs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Add new environments
====================

Please follow the steps provided in the :gymnasium:`gymnasium documentation <tutorials/gymnasium_basics/environment_creation>`
when creating a new environment. After you create your environment, you can use the :stable_gym:`stable-gym/stable_gym/__init__.py <blob/main/stable_gym/__init__.py>`
when creating a new environment. After you create your environment, you can use the :stable-gym:`stable-gym/stable_gym/__init__.py <blob/main/stable_gym/__init__.py>`
file to register them to the ``stable_gym`` package.

stable_gym/stable_gym/envs/__init__.py
Expand Down
6 changes: 3 additions & 3 deletions docs/source/dev/doc_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Build the documentation
Install requirements
--------------------

Building the :stable_gym:`Stable Gym <>` documentation requires `sphinx`_,
Building the :stable-gym:`Stable Gym <>` documentation requires `sphinx`_,
the ``stable_gym`` python package and several plugins. All of the above can be
installed using the following `pip`_ command inside the ``./stable_gym`` folder:

Expand All @@ -21,12 +21,12 @@ installed using the following `pip`_ command inside the ``./stable_gym`` folder:
Build the documentation
-----------------------

To build the `HTML`_ documentation, go into the :stable_gym:`docs/ <tree/main/docs>` directory and run the
To build the `HTML`_ documentation, go into the :stable-gym:`docs/ <tree/main/docs>` directory and run the
``make html`` command. This command will generate the html documentation inside the ``docs/build/html`` directory. If the
documentation is successfully built, you can also use the ``make linkcheck`` command to check for broken links.

.. attention::
Make sure you are in the Conda environment in which you installed the :stable_gym:`stable_gym <>` package
Make sure you are in the Conda environment in which you installed the :stable-gym:`stable_gym <>` package
with it's dependencies.

.. note::
Expand Down
4 changes: 2 additions & 2 deletions docs/source/envs/envs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Environments
============

The :stable_gym:`Stable Gym package <>` provides a variety of environments for training and testing
The :stable-gym:`Stable Gym package <>` provides a variety of environments for training and testing
:stable_learning_control:`(stable) reinforcement learning (RL) algorithms <>`.

Biological environments
Expand Down Expand Up @@ -67,4 +67,4 @@ Robotics environment

.. note::
The ROS robotics environments of the Stable Gym package were moved into a separate package
called :ros_gazebo_gym:`Ros Gazebo Gym <>`.
called :ros-gazebo-gym:`Ros Gazebo Gym <>`.
4 changes: 2 additions & 2 deletions docs/source/get_started/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
How to use
==========

The environments in the :stable_gym:`Stable Gym <>` package can be imported like any other
The environments in the :stable-gym:`Stable Gym <>` package can be imported like any other
:gymnasium:`gymnasium environments <>`. You can then use the :func:`gym.vector.make` function to create an instance of
the environment. Here's a bare minimum example of using one of the :ref:`Stable Gym environment <envs>`. This will run an instance of the
:ref:`Oscillator-v1 <oscillator>` environment for 1000 timesteps. You should see the observations
being printed to the console. More examples can be found in the :stable_gym:`Stable Gym examples folder <tree/main/examples>`.
being printed to the console. More examples can be found in the :stable-gym:`Stable Gym examples folder <tree/main/examples>`.

.. literalinclude:: ../../../examples/use_stable_gym.py
:language: python
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Welcome to Stable Gym's documentation
:width: 80%
:align: center

The :stable_gym:`Stable Gym <>` package contains several :gymnasium:`gymnasium environments <>`
The :stable-gym:`Stable Gym <>` package contains several :gymnasium:`gymnasium environments <>`
with cost functions compatible with (stable) RL agents. It was initially created for the stable RL
algorithms in the :stable_learning_control:`Stable Learning Control <>` package but can be
used with any RL agent requiring a **positive definite cost function**. For more information about stable
Expand Down
10 changes: 5 additions & 5 deletions stable_gym/envs/classic_control/ex3_ekf/ex3_ekf.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ def __init__(
self.sigma = 0

# Displacement limit set to be [-high, high]
high = np.array([10000, 10000, 10000, 10000], dtype=np.float32)
high = np.array([10000, 10000, 10000, 10000], dtype=np.float64)

self.action_space = spaces.Box(
low=np.array([-10.0, -10.0], dtype=np.float32),
high=np.array([10.0, 10.0], dtype=np.float32),
dtype=np.float32,
low=np.array([-10.0, -10.0], dtype=np.float64),
high=np.array([10.0, 10.0], dtype=np.float64),
dtype=np.float64,
)
self.observation_space = spaces.Box(-high, high, dtype=np.float32)
self.observation_space = spaces.Box(-high, high, dtype=np.float64)
self.reward_range = (0.0, 100.0)

self._clipped_action = clipped_action
Expand Down

0 comments on commit 81154d8

Please sign in to comment.