docs: Add validation info (#151)

HCookie · web-flow · commit f132803fd368 · 2025-02-25T17:16:18.000Z
diff --git a/docs/cli/validate.rst b/docs/cli/validate.rst
@@ -0,0 +1,18 @@
+validate
+==========
+
+It is possible to investigate a checkpoint file and determine if the environment matches,
+or if anemoi packages differ in version between the inference and the training environment.
+
+This can be very useful to resolve issues when running an older or shared checkpoint.
+
+*********
+ Usage
+*********
+
+
+.. argparse::
+    :module: anemoi.inference.__main__
+    :func: create_parser
+    :prog: anemoi-inference
+    :path: validate
diff --git a/docs/index.rst b/docs/index.rst
@@ -67,6 +67,7 @@ of the *Anemoi* packages.
    cli/introduction
    cli/run
    cli/metadata
+   cli/validate
 
 .. toctree::
    :maxdepth: 1
diff --git a/pyproject.toml b/pyproject.toml
@@ -63,7 +63,7 @@ optional-dependencies.docs = [
   "nbsphinx",
   "pandoc",
   "rstfmt",
-  "sphinx",
+  "sphinx<8.2",
   "sphinx-argparse<0.5",
   "sphinx-rtd-theme",
 ]
