#915 - Refactored documentation and included APi docs, dependencies.

- make files now re-build autosummary and deps file.
- Added typer and platformdirs to deps in pyproject.toml.
- Made root_is_pure = True in setup.py as platform/python specific wheels don't need to be built but the option is there should we need to.
-
Added an e2e test for primaite.main.run func.

tests/conftest.py

@@ -15,7 +15,6 @@ def _get_temp_session_path(session_timestamp: datetime) -> Path:
     """
     Get a temp directory session path the test session will output to.
 
-
     :param session_timestamp: This is the datetime that the session started.
     :return: The session directory path.
     """
@@ -28,11 +27,9 @@ def _get_temp_session_path(session_timestamp: datetime) -> Path:
 
 
 def _get_primaite_env_from_config(
-        training_config_path: Union[str, Path],
-        lay_down_config_path: Union[str, Path]
+    training_config_path: Union[str, Path], lay_down_config_path: Union[str, Path]
 ):
     """Takes a config path and returns the created instance of Primaite."""
-
     session_timestamp: datetime = datetime.now()
     session_path = _get_temp_session_path(session_timestamp)
 
@@ -44,12 +41,12 @@ def _get_primaite_env_from_config(
         session_path=session_path,
         timestamp_str=timestamp_str,
     )
-    config_values = env.config_values
+    config_values = env.training_config
     config_values.num_steps = env.episode_steps
 
     # TOOD: This needs t be refactored to happen outside. Should be part of
     # a main Session class.
-    if env.config_values.agent_identifier == "GENERIC":
+    if env.training_config.agent_identifier == "GENERIC":
         run_generic(env, config_values)
 
     return env

tests/e2e_integration_tests/test_primaite_main.py

@@ -0,0 +1,8 @@
+from primaite.config.lay_down_config import data_manipulation_config_path
+from primaite.config.training_config import main_training_config_path
+from primaite.main import run
+
+
+def test_primaite_main_e2e():
+    """Tests the primaite.main.run function end-to-end."""
+    run(main_training_config_path(), data_manipulation_config_path())

tests/test_training_config.py

@@ -16,8 +16,7 @@ def test_legacy_lay_down_config_yaml_conversion():
     with open(new_path, "r") as file:
         new_dict = yaml.safe_load(file)
 
-    converted_dict = training_config.convert_legacy_training_config_dict(
-        legacy_dict)
+    converted_dict = training_config.convert_legacy_training_config_dict(legacy_dict)
 
     assert converted_dict == new_dict