Skip to content

Commit

Permalink
feat(disturber): remove disturber class
Browse files Browse the repository at this point in the history
This commit removes the disturber superclass now that this functionality was moved to the
https://github.com/rickstaa/stable-learning-control package (see
rickstaa/stable-learning-control#313).
  • Loading branch information
rickstaa committed Aug 2, 2023
1 parent 0b20409 commit 77e7378
Show file tree
Hide file tree
Showing 16 changed files with 19 additions and 2,160 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We love your input! 🚀 We want to make contributing to this project as easy an

We use Github to host code, track issues and feature requests, and accept pull requests.

### We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
### We Use [Github Flow](https://docs.github.com/en), So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:

Expand Down Expand Up @@ -96,4 +96,4 @@ See the [documentation guidelines](https://rickstaa.dev/stable-gym/dev/doc_dev.h

## Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](https://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
7 changes: 6 additions & 1 deletion docs/source/dev/doc_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@ To build the `HTML`_ documentation, go into the :stable_gym:`docs/ <tree/main/do
``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.

.. note::
.. 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.

.. _HTML: https://www.w3schools.com/html/

Deploying
Expand Down
2 changes: 1 addition & 1 deletion docs/source/get_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Installing Python

You are recommended to install Python through Anaconda. Anaconda is a library that includes Python and many valuable packages for
Python, as well as an environment manager called Conda, makes package management simple. To install Anaconda, please follow the
installation instructions on the `official website <https://docs.continuum.io/anaconda/install/>`_. After downloading and
installation instructions on the `official website <https://docs.continuum.io/free/anaconda/install//>`_. After downloading and
installing Anaconda3 (at the time of writing, `Anaconda3-2023.3.1`_), create a Conda Python env for organizing packages used
in the ``stable_gym`` package:

Expand Down
1 change: 0 additions & 1 deletion stable_gym/common/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
"""Contains several functions that can be used across all the Stable Gym gymnasium
environments.
"""
from stable_gym.common.disturber import Disturber
from stable_gym.common.max_episode_steps_injection_wrapper import (
MaxEpisodeStepsInjectionWrapper,
)
85 changes: 0 additions & 85 deletions stable_gym/common/disturbances.py

This file was deleted.

Loading

0 comments on commit 77e7378

Please sign in to comment.