Skip to content

Commit

Permalink
docs: improve admonitions (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Aug 11, 2023
1 parent 0fb571b commit 956d923
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 4 deletions.
2 changes: 0 additions & 2 deletions docs/source/dev/doc_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,10 @@ To build the `HTML`_ documentation, go into the :stable_gym:`docs/ <tree/main/do
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
with it's dependencies.

.. note::

Sometimes the ``make linkcheck`` command doesn't show the results on the stdout. You can also find the results
in the ``docs/build/linkcheck`` folder.

Expand Down
1 change: 0 additions & 1 deletion docs/source/envs/envs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,5 @@ Robotics environment
./robotics/quadx_waypoints_cost.rst

.. note::

The ROS robotics environments of the Stable Gym package were moved into a separate package
called :ros_gazebo_gym:`Ros Gazebo Gym <>`.
1 change: 0 additions & 1 deletion docs/source/get_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ To use Python from the environment you just created, activate the environment wi
conda activate stable_gym
.. note::

Alternatively, you can use Python's `venv <https://docs.python.org/3/library/venv.html>`_ package to create a virtual environment.

.. _`Anaconda3-2023.3.1`: https://repo.anaconda.com/archive/
Expand Down

0 comments on commit 956d923

Please sign in to comment.