Add subheadings to schema doc page

ecmwf · Feb 20, 2025 · 7372610 · 7372610
1 parent b63f1aa
commit 7372610
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/training/docs/modules/schemas.rst b/training/docs/modules/schemas.rst
@@ -11,21 +11,40 @@ yaml matches the BaseSchema.
    :no-undoc-members:
    :show-inheritance:
 
+The below schemas are organised below identically to the training config
+files,
+
+******
+ Data
+******
+
 .. automodule:: anemoi.training.schemas.data
    :members:
    :no-undoc-members:
    :show-inheritance:
 
+************
+ Dataloader
+************
+
 .. automodule:: anemoi.training.schemas.dataloader
    :members:
    :no-undoc-members:
    :show-inheritance:
 
+**********
+ Hardware
+**********
+
 .. automodule:: anemoi.training.schemas.hardware
    :members:
    :no-undoc-members:
    :show-inheritance:
 
+*******
+ Graph
+*******
+
 .. automodule:: anemoi.training.schemas.graphs.basegraph
    :members:
    :no-undoc-members:
@@ -41,6 +60,10 @@ yaml matches the BaseSchema.
    :no-undoc-members:
    :show-inheritance:
 
+*******
+ Model
+*******
+
 .. automodule:: anemoi.training.schemas.models.models
    :members:
    :no-undoc-members:
@@ -61,6 +84,10 @@ yaml matches the BaseSchema.
    :no-undoc-members:
    :show-inheritance:
 
+**********
+ Training
+**********
+
 .. automodule:: anemoi.training.schemas.training
    :members:
    :no-undoc-members: