Fix the gif link

Farama-Foundation · Oct 1, 2024 · c3207af · c3207af
1 parent 0ae9753
commit c3207af
Show file tree

Hide file tree

Showing 106 changed files with 165 additions and 162 deletions.
diff --git a/docs/_scripts/gen_environment_page.py b/docs/_scripts/gen_environment_page.py
@@ -1,5 +1,4 @@
 import itertools
-import json
 
 import ale_py
 import gymnasium
@@ -75,4 +74,4 @@ def shortened_repr(values):
     )
     env.close()
 
-print(tabulate.tabulate(rows, headers=headers, tablefmt="github"))
+print(tabulate.tabulate(rows, headers=headers, tablefmt="github"))
diff --git a/docs/_scripts/gen_environments_md.py b/docs/_scripts/gen_environments_md.py
@@ -57,7 +57,7 @@ def shortened_repr(values):
     if env_data["reward_description"]:
         reward_description = f"""
 ### Reward
-        
+
 {env_data["reward_description"]}
 """
     else:
@@ -129,11 +129,15 @@ def shortened_repr(values):
         difficulty_mode_row, headers=difficulty_mode_header, tablefmt="github"
     )
 
-    top_table = tabulate.tabulate([
-        ["Action Space", str(env.action_space)],
-        ["Observation Space", str(env.observation_space)],
-        ["Import", f'`gymnasium.make("{env.spec.id}")`']
-    ], headers=["", ""], tablefmt="github")
+    top_table = tabulate.tabulate(
+        [
+            ["Action Space", str(env.action_space)],
+            ["Observation Space", str(env.observation_space)],
+            ["Import", f'`gymnasium.make("{env.spec.id}")`'],
+        ],
+        headers=["", ""],
+        tablefmt="github",
+    )
 
     env.close()
 
@@ -143,7 +147,7 @@ def shortened_repr(values):
 
 # {env_name}
 
-```{{figure}} ../../_static/videos/environments/{rom_id}.gif
+```{{figure}} ../_static/videos/environments/{rom_id}.gif
 :width: 120px
 :name: {env_name}
 ```

diff --git a/docs/environments/adventure.md b/docs/environments/adventure.md
@@ -4,7 +4,7 @@ title: Adventure
 
 # Adventure
 
-```{figure} ../../_static/videos/environments/adventure.gif
+```{figure} ../_static/videos/environments/adventure.gif
 :width: 120px
 :name: Adventure
 ```

diff --git a/docs/environments/air_raid.md b/docs/environments/air_raid.md
@@ -4,7 +4,7 @@ title: AirRaid
 
 # AirRaid
 
-```{figure} ../../_static/videos/environments/air_raid.gif
+```{figure} ../_static/videos/environments/air_raid.gif
 :width: 120px
 :name: AirRaid
 ```

diff --git a/docs/environments/alien.md b/docs/environments/alien.md
@@ -4,7 +4,7 @@ title: Alien
 
 # Alien
 
-```{figure} ../../_static/videos/environments/alien.gif
+```{figure} ../_static/videos/environments/alien.gif
 :width: 120px
 :name: Alien
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught by an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a table of scores corresponding to the different achievements, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815).
 
 ## Variants

diff --git a/docs/environments/amidar.md b/docs/environments/amidar.md
@@ -4,7 +4,7 @@ title: Amidar
 
 # Amidar
 
-```{figure} ../../_static/videos/environments/amidar.gif
+```{figure} ../_static/videos/environments/amidar.gif
 :width: 120px
 :name: Amidar
 ```
@@ -51,7 +51,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817).
 
 ## Variants

diff --git a/docs/environments/assault.md b/docs/environments/assault.md
@@ -4,7 +4,7 @@ title: Assault
 
 # Assault
 
-```{figure} ../../_static/videos/environments/assault.gif
+```{figure} ../_static/videos/environments/assault.gif
 :width: 120px
 :name: Assault
 ```

diff --git a/docs/environments/asterix.md b/docs/environments/asterix.md
@@ -4,7 +4,7 @@ title: Asterix
 
 # Asterix
 
-```{figure} ../../_static/videos/environments/asterix.gif
+```{figure} ../_static/videos/environments/asterix.gif
 :width: 120px
 :name: Asterix
 ```
@@ -50,7 +50,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 A table of scores awarded for collecting the different objects is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325).
 
 ## Variants

diff --git a/docs/environments/asteroids.md b/docs/environments/asteroids.md
@@ -4,7 +4,7 @@ title: Asteroids
 
 # Asteroids
 
-```{figure} ../../_static/videos/environments/asteroids.gif
+```{figure} ../_static/videos/environments/asteroids.gif
 :width: 120px
 :name: Asteroids
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score for destroying it. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL).
 
 ## Variants

diff --git a/docs/environments/atlantis.md b/docs/environments/atlantis.md
@@ -4,7 +4,7 @@ title: Atlantis
 
 # Atlantis
 
-```{figure} ../../_static/videos/environments/atlantis.gif
+```{figure} ../_static/videos/environments/atlantis.gif
 :width: 120px
 :name: Atlantis
 ```
@@ -49,7 +49,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
 
 ## Variants

diff --git a/docs/environments/atlantis2.md b/docs/environments/atlantis2.md
@@ -4,7 +4,7 @@ title: Atlantis2
 
 # Atlantis2
 
-```{figure} ../../_static/videos/environments/atlantis2.gif
+```{figure} ../_static/videos/environments/atlantis2.gif
 :width: 120px
 :name: Atlantis2
 ```
@@ -49,7 +49,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
 
 ## Variants

diff --git a/docs/environments/backgammon.md b/docs/environments/backgammon.md
@@ -4,7 +4,7 @@ title: Backgammon
 
 # Backgammon
 
-```{figure} ../../_static/videos/environments/backgammon.gif
+```{figure} ../_static/videos/environments/backgammon.gif
 :width: 120px
 :name: Backgammon
 ```

diff --git a/docs/environments/bank_heist.md b/docs/environments/bank_heist.md
@@ -4,7 +4,7 @@ title: BankHeist
 
 # BankHeist
 
-```{figure} ../../_static/videos/environments/bank_heist.gif
+```{figure} ../_static/videos/environments/bank_heist.gif
 :width: 120px
 :name: BankHeist
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city, you will score extra points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008).
 
 ## Variants

diff --git a/docs/environments/basic_math.md b/docs/environments/basic_math.md
@@ -4,7 +4,7 @@ title: BasicMath
 
 # BasicMath
 
-```{figure} ../../_static/videos/environments/basic_math.gif
+```{figure} ../_static/videos/environments/basic_math.gif
 :width: 120px
 :name: BasicMath
 ```

diff --git a/docs/environments/battle_zone.md b/docs/environments/battle_zone.md
@@ -4,7 +4,7 @@ title: BattleZone
 
 # BattleZone
 
-```{figure} ../../_static/videos/environments/battle_zone.gif
+```{figure} ../_static/videos/environments/battle_zone.gif
 :width: 120px
 :name: BattleZone
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You receive points for destroying enemies. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL).
 
 ## Variants

diff --git a/docs/environments/beam_rider.md b/docs/environments/beam_rider.md
@@ -4,7 +4,7 @@ title: BeamRider
 
 # BeamRider
 
-```{figure} ../../_static/videos/environments/beam_rider.gif
+```{figure} ../_static/videos/environments/beam_rider.gif
 :width: 120px
 :name: BeamRider
 ```
@@ -50,7 +50,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points for destroying enemies. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL).
 
 ## Variants

diff --git a/docs/environments/berzerk.md b/docs/environments/berzerk.md
@@ -4,7 +4,7 @@ title: Berzerk
 
 # Berzerk
 
-```{figure} ../../_static/videos/environments/berzerk.gif
+```{figure} ../_static/videos/environments/berzerk.gif
 :width: 120px
 :name: Berzerk
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points for destroying robots. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL).
 
 ## Variants

diff --git a/docs/environments/blackjack.md b/docs/environments/blackjack.md
@@ -4,7 +4,7 @@ title: Blackjack
 
 # Blackjack
 
-```{figure} ../../_static/videos/environments/blackjack.gif
+```{figure} ../_static/videos/environments/blackjack.gif
 :width: 120px
 :name: Blackjack
 ```

diff --git a/docs/environments/bowling.md b/docs/environments/bowling.md
@@ -4,7 +4,7 @@ title: Bowling
 
 # Bowling
 
-```{figure} ../../_static/videos/environments/bowling.gif
+```{figure} ../_static/videos/environments/bowling.gif
 :width: 120px
 :name: Bowling
 ```
@@ -49,7 +49,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You receive points for knocking down pins. The exact score depends on whether you manage a "strike", "spare" or "open" frame. Moreover, the points you score for one frame may depend on following frames. You can score up to 300 points in one game (if you manage to do 12 strikes). For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879).
 
 ## Variants

diff --git a/docs/environments/boxing.md b/docs/environments/boxing.md
@@ -4,7 +4,7 @@ title: Boxing
 
 # Boxing
 
-```{figure} ../../_static/videos/environments/boxing.gif
+```{figure} ../_static/videos/environments/boxing.gif
 :width: 120px
 :name: Boxing
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points by landing punches. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882).
 
 ## Variants

diff --git a/docs/environments/breakout.md b/docs/environments/breakout.md
@@ -4,7 +4,7 @@ title: Breakout
 
 # Breakout
 
-```{figure} ../../_static/videos/environments/breakout.gif
+```{figure} ../_static/videos/environments/breakout.gif
 :width: 120px
 :name: Breakout
 ```
@@ -49,7 +49,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889).
 
 ## Variants

diff --git a/docs/environments/carnival.md b/docs/environments/carnival.md
@@ -4,7 +4,7 @@ title: Carnival
 
 # Carnival
 
-```{figure} ../../_static/videos/environments/carnival.gif
+```{figure} ../_static/videos/environments/carnival.gif
 :width: 120px
 :name: Carnival
 ```
@@ -49,7 +49,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign. You will score extra points if it shows a plus sign! For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908).
 
 ## Variants

diff --git a/docs/environments/casino.md b/docs/environments/casino.md
@@ -4,7 +4,7 @@ title: Casino
 
 # Casino
 
-```{figure} ../../_static/videos/environments/casino.gif
+```{figure} ../_static/videos/environments/casino.gif
 :width: 120px
 :name: Casino
 ```

diff --git a/docs/environments/centipede.md b/docs/environments/centipede.md
@@ -4,7 +4,7 @@ title: Centipede
 
 # Centipede
 
-```{figure} ../../_static/videos/environments/centipede.gif
+```{figure} ../_static/videos/environments/centipede.gif
 :width: 120px
 :name: Centipede
 ```
@@ -52,7 +52,7 @@ Atari environments have three possible observation types:
 See variants section for the type of observation used by each environment id by default.
 
 ### Reward
-        
+
 You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round (i.e. after you have lost a wand) for mushrooms that were not destroyed. Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911).
 
 ## Variants