CNAME and dependencies for Documentations (#245)

CNAME

@@ -1 +1 @@
-fenggu.me
+minigrid.farama.org

docs/conf.py

@@ -71,7 +71,7 @@ napoleon_custom_sections = [("Returns", "params_style")]
 #
 html_theme = "furo"
 html_title = "MiniGrid Documentation"
-html_baseurl = "https://fenggu.me/"
+html_baseurl = "https://minigrid.farama.org/"
 html_copy_source = False
 html_favicon = "_static/img/minigrid-white.png"
 html_theme_options = {
@@ -82,5 +82,3 @@ html_static_path = ["_static"]
 html_css_files = [
     "css/custom.css",
 ]
-
-notfound_urls_prefix = "/MiniGrid/"

docs/environments/blocked_unlock_pickup.md

@@ -40,7 +40,7 @@ room. This environment can be solved without relying on language.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/dist_shift2.md

@@ -37,7 +37,7 @@ one variant and tested on the other.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/door_key.md

@@ -34,7 +34,7 @@ useful to experiment with curiosity or curriculum learning.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/dynamic.md

@@ -36,7 +36,7 @@ Partial Observability.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/empty.md

@@ -38,7 +38,7 @@ agent always starting in the corner opposite to the goal.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/fetch.md

@@ -42,7 +42,7 @@ zero reward.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/four_rooms.md

@@ -34,7 +34,7 @@ the agent and the goal square are randomly placed in any of the four rooms.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/go_to_door.md

@@ -38,7 +38,7 @@ string.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/key_corridor_s6_r3.md

@@ -42,7 +42,7 @@ key is placed. This environment can be solved without relying on language.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/lava_gap_s7.md

@@ -36,7 +36,7 @@ Depending on the `obstacle_type` parameter:
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/locked_room.md

@@ -38,7 +38,7 @@ difficult to solve with vanilla reinforcement learning alone.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/memory_s7.md

@@ -35,7 +35,7 @@ object, and go to the matching object at split.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/multi_room.md

@@ -35,7 +35,7 @@ and building a curriculum, the environment can be solved.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/put_near.md

@@ -39,7 +39,7 @@ understanding and spatial reasoning involving multiple objects.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/red_blue_doors.md

@@ -34,7 +34,7 @@ solvable without memory.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/simple_crossing_s11_n5.md

@@ -42,7 +42,7 @@ Depending on the `obstacle_type` parameter:
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/unlock.md

@@ -32,7 +32,7 @@ relying on language.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/environments/unlock_pickup.md

@@ -35,7 +35,7 @@ locked door. This environment can be solved without relying on language.
 - Each tile is encoded as a 3 dimensional tuple:
     `(OBJECT_IDX, COLOR_IDX, STATE)`
 - `OBJECT_TO_IDX` and `COLOR_TO_IDX` mapping can be found in
-    [gym_minigrid/minigrid.py](gym_minigrid/minigrid.py)
+    [minigrid/minigrid.py](minigrid/minigrid.py)
 - `STATE` refers to the door state with 0=open, 1=closed and 2=locked
 
 ### Rewards

docs/scripts/gen_mds.py

@@ -8,7 +8,7 @@ __email__ = "contact@fenggu.me"
 import os
 import re
 
-from gym.envs.registration import registry
+from gymnasium.envs.registration import registry
 from tqdm import tqdm
 
 from utils import trim
@@ -23,11 +23,11 @@ filtered_envs_by_type = {}
 
 # Obtain filtered list
 for env_spec in tqdm(all_envs):
-    # gym_minigrid.envs:Env
+    # minigrid.envs:Env
     split = env_spec.entry_point.split(".")
     # ignore gymnasium.envs.env_type:Env
     env_module = split[0]
-    if env_module != "gym_minigrid":
+    if env_module != "minigrid":
         continue
 
     env_name = split[1]
@@ -53,7 +53,6 @@ for env_name, env_spec in filtered_envs.items():
 
     v_path = os.path.join(
         os.path.dirname(os.path.dirname(__file__)),
-        "source",
         "environments",
         snake_env_name + ".md",
     )