update builtin envs docs

Author: jakegrigsby

.github/workflows/gh-pages.yml

@@ -26,7 +26,6 @@ jobs:
         run: |
           pip install --upgrade pip
           pip install -e .
-          pip install gymnasium[mujoco]
           pip install -e .[envs]
 
       - name: Install docs dependencies

amago/envs/amago_env.py

@@ -1,3 +1,7 @@
+"""
+Main environment wrapper stack for sequence data and parallel logging.
+"""
+
 import os
 import random
 import warnings

amago/envs/builtin/mazerunner.py

@@ -9,7 +9,6 @@
 import gymnasium as gym
 import numpy as np
 import matplotlib.pyplot as plt
-from matplotlib.artist import Artist
 
 from amago.envs import AMAGOEnv
 

amago/envs/env_utils.py

@@ -1,3 +1,7 @@
+"""
+Miscellaneous environment wrappers and utilities.
+"""
+
 import gymnasium as gym
 import numpy as np
 

amago/envs/exploration.py

@@ -1,3 +1,7 @@
+"""
+Exploration via gymnasium wrappers.
+"""
+
 from abc import ABC, abstractmethod
 
 import gymnasium as gym

docs/conf.py

@@ -96,6 +96,7 @@ def setup(app):
 # (Optional) hide function/class signatures in the summary table
 autosummary_imported_members = False
 autodoc_property_type = True
+autodoc_mock_imports = ["xminigrid", "ale_py", "jax", "metaworld", "dm_env", "gymnax", "dm_alchemy", "minigrid", "retro", "cv2", "matplotlib", "procgen"]
 
 napoleon_custom_sections = [
     ("Gin Configurable Keyword Args", "Args"),

setup.py

@@ -32,13 +32,11 @@
             # deepmind alchemy
             "dm_env",
             "dm_alchemy @ git+https://github.com/deepmind/dm_alchemy.git",
-            "xminigrid",
             "gymnax",
             "matplotlib",
             "opencv-python",
             "procgen",
             "minigrid",
-            "xminigrid",
             "ale_py>=0.10",
         ],
         "flash": ["ninja", "packaging", "flash-attn"],