Fix/ Fix docs build.

docs/environments/smac.md

@@ -1 +1 @@
-Currently supported through the [PettingZoo Wrapper](pettingzoo).
+::: mava.wrappers.smac

docs/systems/tf/value_decomposition.md

@@ -0,0 +1,3 @@
+--8<-- "mava/systems/tf/value_decomposition/README.md"
+
+::: mava.systems.tf.value_decomposition

mava/utils/environments/flatland_utils.py

@@ -22,7 +22,27 @@
 )
 from mava.wrappers.flatland import FlatlandEnvWrapper
 
-try:
+
+def check_flatland_import() -> bool:
+    """Consistent way to check if flatland has been installed.
+
+    Returns:
+        whether flatland exists or not.
+    """
+    try:
+        from flatland.envs.line_generators import sparse_line_generator
+
+        # Delete unused var
+        del sparse_line_generator
+        _found_flatland = True
+
+    except ModuleNotFoundError:
+        _found_flatland = False
+    return _found_flatland
+
+
+_found_flatland = check_flatland_import()
+if _found_flatland:
     from flatland.envs.line_generators import sparse_line_generator
     from flatland.envs.malfunction_generators import (
         MalfunctionParameters,
@@ -33,13 +53,6 @@
     from flatland.envs.rail_env import RailEnv
     from flatland.envs.rail_generators import sparse_rail_generator
 
-    _found_flatland = True
-
-except ModuleNotFoundError:
-    _found_flatland = False
-
-if _found_flatland:
-
     def _create_rail_env_with_tree_obs(
         n_agents: int = 5,
         x_dim: int = 30,

mava/wrappers/flatland.py

@@ -22,10 +22,17 @@
 import numpy as np
 from acme import specs
 from acme.wrappers.gym_wrapper import _convert_to_spec
-from flatland.envs.observations import GlobalObsForRailEnv, Node, TreeObsForRailEnv
-from flatland.envs.rail_env import RailEnv
-from flatland.envs.step_utils.states import TrainState
-from flatland.utils.rendertools import AgentRenderVariant, RenderTool
+
+try:
+    from flatland.envs.observations import GlobalObsForRailEnv, Node, TreeObsForRailEnv
+    from flatland.envs.rail_env import RailEnv
+    from flatland.envs.step_utils.states import TrainState
+    from flatland.utils.rendertools import AgentRenderVariant, RenderTool
+except ModuleNotFoundError:
+    # Without these types - the docs fail.
+    # TODO(Kale-ab): Remove this hack.
+    RailEnv = Any
+    Node = Any
 from gym.spaces import Discrete
 from gym.spaces.box import Box
 

mkdocs.yml

@@ -46,9 +46,7 @@ nav:
       - mad4pg: systems/tf/mad4pg.md
       - mappo: systems/tf/mappo.md
       - madqn: systems/tf/madqn.md
-      - vdn: systems/tf/vdn.md
-      - qmix: systems/tf/qmix.md
-      - dial: systems/tf/dial.md
+      - vdn and qmix: systems/tf/value_decomposition.md
   - Environments:
     - General: environments/general.md
     - Supported Environments:

tests/utils/environment_utils_test.py

@@ -18,14 +18,12 @@
 import pytest
 
 from mava.utils.environments import debugging_utils, pettingzoo_utils
+from mava.utils.environments.flatland_utils import check_flatland_import
 
-try:
-    from mava.utils.environments import flatland_utils
+_has_flatland = check_flatland_import()
 
-    _has_flatland = True
-except (ModuleNotFoundError, ImportError):
-    _has_flatland = False
-    pass
+if _has_flatland:
+    from mava.utils.environments import flatland_utils
 
 
 @pytest.mark.parametrize(

tests/wrappers/wrapper_test.py

@@ -22,16 +22,11 @@
 from _pytest.monkeypatch import MonkeyPatch
 
 from mava import types
+from mava.utils.environments.flatland_utils import check_flatland_import
 from tests.conftest import EnvSpec, EnvType, Helpers
 from tests.enums import EnvSource
 
-try:
-    import flatland  # noqa: F401
-
-    _has_flatland = True
-except (ModuleNotFoundError, ImportError):
-    _has_flatland = False
-    pass
+_has_flatland = check_flatland_import()
 """
 TestEnvWrapper is a general purpose test class that runs tests for environment wrappers.
 This is meant to flexibily test various environments wrappers.