Merge branch 'schema-updates' into add-trial-runner-id-column

doc/source/conf.py

@@ -146,6 +146,7 @@ def is_on_github_actions():
 )
 intersphinx_mapping.update(
     {
+        "alembic": ("https://alembic.sqlalchemy.org/en/latest/", None),
         "dabl": ("https://dabl.github.io/stable/", None),
     }
 )
@@ -216,6 +217,7 @@ def setup(app: SphinxApp) -> None:
     # External classes that refuse to resolve:
     ("py:class", "contextlib.nullcontext"),
     ("py:class", "sqlalchemy.engine.Engine"),
+    ("py:class", "sqlalchemy.MetaData"),
     ("py:exc", "jsonschema.exceptions.SchemaError"),
     ("py:exc", "jsonschema.exceptions.ValidationError"),
 ]
@@ -253,6 +255,9 @@ def setup(app: SphinxApp) -> None:
     # Don't document internal environment scripts that aren't part of a module.
     "*/mlos_bench/config/environments/*/*.py",
     "*/mlos_bench/config/services/*/*.py",
+    # Don't document schema evolution scripts.
+    "*/mlos_bench/storage/sql/alembic/*.py",
+    "*/mlos_bench/storage/sql/alembic/versions/*.py",
 ]
 autoapi_options = [
     "members",

mlos_bench/mlos_bench/storage/sql/schema.py

@@ -81,8 +81,10 @@ def __init__(self, engine: Engine | None):
         ----------
         engine : sqlalchemy.engine.Engine | None
             The SQLAlchemy engine to use for the DB schema.
-            Listed as optional for :external:mod:`alembic` schema migration
-            purposes, but won't be functional without one.
+            Listed as optional for `alembic <https://alembic.sqlalchemy.org>`_
+            schema migration purposes so we can reference it inside it's ``env.py``
+            config file for :attr:`~meta` data inspection, but won't generally be
+            functional without one.
         """
         _LOG.info("Create the DB schema for: %s", engine)
         self._engine = engine