DOC: Template contractual items

docs/src/conf.py

@@ -63,6 +63,8 @@ def _myst_substitutions() -> dict[str, SchemaBase]:
 
             ```
         """)
+        if hasattr(s, "CONTRACTUAL"):
+            s.contractual = "\n".join([f"- `{item}`" for item in s.CONTRACTUAL])
         subs[f"{s.__name__}"] = s
     return subs
 

docs/src/datamodel/index.md

@@ -64,15 +64,15 @@ This data model covers data produced by FMU workflows. This includes data genera
 direct runs of model templates, data produced by pre-processing workflows, data produced
 in individual realizations or hooked workflows, and data produced by post-processing workflows.
 
-```{note}
+:::{note}
 An example of a pre-processing workflow is a set of jobs modifying selected input data
 for later use in the FMU workflows and/or for comparison with other results in a QC context.
-```
+:::
 
-```{note}
+:::{note}
 An example of a post-processing workflow is a script that aggregates results across many
 realizations and/or iterations of an FMU case.
-```
+:::
 
 This data model covers data that, in the FMU context, can be linked to a specific case.
 
@@ -101,14 +101,14 @@ Second, a denormalized data model enables us to utilize search engine technologi
 for indexing. This is not efficient for a normalized data model. The penalty for
 duplicating metadata across many individual files is returned in speed and ease-of-use.
 
-```{note}
+:::{note}
 The data model is only denormalized *to a certain point*. Most likely, it is better
 described as a hybrid. Example: The concept of a *case* is used in FMU context. In the
 outgoing metadata for FMU results, some information about the current case is included.
 However, *details* about the case is out of scope. For this, a consumer would have to
 refer to the owner of the *case* definition. In FMU contexts, this will be the workflow
 manager (ERT).
-```
+:::
 
 
 ### Standardized vs anarchy
@@ -317,38 +317,7 @@ To handle this, two important concepts has been introduced.
 
 The following attributes are contractual:
 
-**{{ FmuResultsSchema.CONTRACTUAL }}**
-* class
-* source
-* version
-* tracklog
-* data.format
-* data.name
-* data.stratigraphic
-* data.alias
-* data.stratigraphic_alias
-* data.offset
-* data.content
-* data.vertical_domain
-* data.grid_model
-* data.bbox
-* data.is_prediction
-* data.is_observation
-* data.seismic.attribute
-* access
-* masterdata
-* fmu.model
-* fmu.workflow
-* fmu.case
-* fmu.iteration
-* fmu.realization.name
-* fmu.realization.id
-* fmu.realization.uuid
-* fmu.aggregation.operation
-* fmu.aggregation.realization_ids
-* file.relative_path
-* file.checksum_md5
-
+{{ FmuResultsSchema.contractual }}
 
 ## Metadata example