add guidance text

HDRUK · Jun 10, 2024 · b25d557 · b25d557
1 parent 9f983a6
commit b25d557
Show file tree

Hide file tree

Showing 8 changed files with 503 additions and 508 deletions.
diff --git a/docs/HDRUK/3.0.0.form.json b/docs/HDRUK/3.0.0.form.json
diff --git a/docs/HDRUK/3.0.0.md b/docs/HDRUK/3.0.0.md
diff --git a/docs/HDRUK/3.0.0.structure.json b/docs/HDRUK/3.0.0.structure.json
diff --git a/hdr_schemata/models/HDRUK/v3_0_0/EnrichmentAndLinkage.py b/hdr_schemata/models/HDRUK/v3_0_0/EnrichmentAndLinkage.py
@@ -14,19 +14,19 @@ class Config:
         extra = "forbid"
 
     derivedFrom: Optional[List[DatasetDescriptor]] = Field(
-        None, **an.derivedFrom.__dict__, json_schema_extra={"guidance": an.derivedFrom.guidance}
+        None, **an.derivedFrom.__dict__
     )
 
     isPartOf: Optional[List[DatasetDescriptor]] = Field(
-        None, **an.isPartOf.__dict__, json_schema_extra={"guidance": an.isPartOf.guidance}
+        None, **an.isPartOf.__dict__
     )
 
     linkableDatasets: Optional[List[DatasetDescriptor]] = Field(
-        None, **an.linkableDatasets.__dict__, json_schema_extra={"guidance": an.linkableDatasets.guidance}
+        None, **an.linkableDatasets.__dict__
     )
 
     similarToDatasets: Optional[List[DatasetDescriptor]] = Field(
-        None, **an.similarToDatasets.__dict__, json_schema_extra={"guidance": an.similarToDatasets.guidance}
+        None, **an.similarToDatasets.__dict__
     )
 
     investigations: Optional[List[Url]] = Field(

diff --git a/hdr_schemata/models/HDRUK/v3_0_0/Summary.py b/hdr_schemata/models/HDRUK/v3_0_0/Summary.py
@@ -18,7 +18,7 @@ class Config:
     )
 
     abstract: AbstractText = Field(
-        ..., **an.abstract.__dict__, json_schema_extra={"guidance": an.title.guidance}
+        ..., **an.abstract.__dict__, json_schema_extra={"guidance": an.abstract.guidance}
     )
 
     dataProvider: Organisation = Field(
@@ -43,4 +43,4 @@ class Config:
 
     alternateIdentifiers: Optional[
         Union[Optional[CommaSeparatedValues], List[Optional[ShortDescription]]]
-    ] = Field(None, **an.alternateIdentifiers.__dict__, json_schema_extra={"guidance": an.alternateIdentifiers.guidance})
+    ] = Field(None, **an.alternateIdentifiers.__dict__)
diff --git a/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml b/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml
diff --git a/hdr_schemata/utils/create_markdown.py b/hdr_schemata/utils/create_markdown.py
@@ -73,8 +73,6 @@ def get_fields(structure, model: type[BaseModel]):
 
         is_list, is_optional, type_names, _types = extract_type_info(_type)
 
-        print(name)
-
         if field.json_schema_extra is not None and "guidance" in field.json_schema_extra:
             guidance = field.json_schema_extra["guidance"]
         else:
@@ -225,29 +223,29 @@ def remove_types(data):
     print(f"Done {path}/name")
 
 
-# from hdr_schemata.models.HDRUK import Hdruk212
-# from hdr_schemata.models.HDRUK import Hdruk213
-# from hdr_schemata.models.HDRUK import Hdruk220  
-# from hdr_schemata.models.HDRUK import Hdruk221
+from hdr_schemata.models.HDRUK import Hdruk212
+from hdr_schemata.models.HDRUK import Hdruk213
+from hdr_schemata.models.HDRUK import Hdruk220  
+from hdr_schemata.models.HDRUK import Hdruk221
 from hdr_schemata.models.HDRUK import Hdruk300
-# from hdr_schemata.models.GWDM.v1_1 import Gwdm10
-# from hdr_schemata.models.GWDM.v1_1 import Gwdm11
-# from hdr_schemata.models.GWDM.v1_2 import Gwdm12
-# from hdr_schemata.models.GWDM.v2_0 import Gwdm20
+from hdr_schemata.models.GWDM.v1_1 import Gwdm10
+from hdr_schemata.models.GWDM.v1_1 import Gwdm11
+from hdr_schemata.models.GWDM.v1_2 import Gwdm12
+from hdr_schemata.models.GWDM.v2_0 import Gwdm20
 
 
-# create_markdown(Hdruk220, "./docs/HDRUK/", "2.2.0")
-# create_markdown(Hdruk221, "./docs/HDRUK/", "2.2.1")
-# create_markdown(Hdruk212, "./docs/HDRUK/", "2.1.2")
-# create_markdown(Hdruk213, "./docs/HDRUK/", "2.1.3")
+create_markdown(Hdruk220, "./docs/HDRUK/", "2.2.0")
+create_markdown(Hdruk221, "./docs/HDRUK/", "2.2.1")
+create_markdown(Hdruk212, "./docs/HDRUK/", "2.1.2")
+create_markdown(Hdruk213, "./docs/HDRUK/", "2.1.3")
 create_markdown(Hdruk300, "./docs/HDRUK/", "3.0.0")
 
-# from hdr_schemata.models.GWDM.v1_1 import Gwdm10
-# from hdr_schemata.models.GWDM.v1_1 import Gwdm11
-# from hdr_schemata.models.GWDM.v1_2 import Gwdm12
-# from hdr_schemata.models.GWDM.v2_0 import Gwdm20   
+from hdr_schemata.models.GWDM.v1_1 import Gwdm10
+from hdr_schemata.models.GWDM.v1_1 import Gwdm11
+from hdr_schemata.models.GWDM.v1_2 import Gwdm12
+from hdr_schemata.models.GWDM.v2_0 import Gwdm20   
 
-# create_markdown(Gwdm10, "./docs/GWDM/", "1.0")
-# create_markdown(Gwdm11, "./docs/GWDM/", "1.1")
-# create_markdown(Gwdm12, "./docs/GWDM/", "1.2")
-# create_markdown(Gwdm20, "./docs/GWDM/", "2.0")
+create_markdown(Gwdm10, "./docs/GWDM/", "1.0")
+create_markdown(Gwdm11, "./docs/GWDM/", "1.1")
+create_markdown(Gwdm12, "./docs/GWDM/", "1.2")
+create_markdown(Gwdm20, "./docs/GWDM/", "2.0")
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -18,11 +18,13 @@ nav:
                 - Version 1.0: GWDM/1.0.md
                 - Version 1.1: GWDM/1.1.md
                 - Version 1.2: GWDM/1.2.md
+                - Version 2.0: GWDM/2.0.md
           - HDRUK:
                 - Version 2.1.2: HDRUK/2.1.2.md
                 - Version 2.1.3: HDRUK/2.1.3.md
                 - Version 2.2.0: HDRUK/2.2.0.md
                 - Version 2.2.1: HDRUK/2.2.1.md
+                - Version 3.0.0: HDRUK/3.0.0.md
     - Schema Change Log:
           - GWDM:
                 - 1.1: GWDM/1.1.change.md