Bootstrapped reference generator

docs/reference/schema.md

@@ -0,0 +1,3 @@
+# Schema
+
+::: dpspecs.Schema

dpspecs/models/schema.py

@@ -5,6 +5,22 @@
 from .base import Model
 
 
+class Schema(Model):
+    """Schema model"""
+
+    name: Optional[str] = None
+    type: Optional[str] = None
+    title: Optional[str] = None
+    description: Optional[str] = None
+
+    fields: List[Field]
+    """List of fields"""
+
+    missingValues: Optional[List[str]] = None
+    primaryKey: Optional[List[str]] = None
+    foreignKeys: Optional[List[ForeignKey]] = None
+
+
 class Field(Model):
     name: str
     type: str
@@ -91,14 +107,3 @@ class ForeignKeyReference(Model):
 class ForeignKey(Model):
     fields: List[str]
     reference: Optional[ForeignKeyReference] = None
-
-
-class Schema(Model):
-    name: Optional[str] = None
-    type: Optional[str] = None
-    title: Optional[str] = None
-    description: Optional[str] = None
-    fields: List[Field]
-    missingValues: Optional[List[str]] = None
-    primaryKey: Optional[List[str]] = None
-    foreignKeys: Optional[List[ForeignKey]] = None

mkdocs.yaml

@@ -58,11 +58,8 @@ theme:
 
 # Plugins
 
-# TODO: enable when it's released to general public
-# https://squidfunk.github.io/mkdocs-material/insiders/#12000-piri-piri
-# plugins:
-  # - blog:
-      # post_date_format: full
+plugins:
+  - mkdocstrings
 
 # Extras
 
@@ -111,5 +108,7 @@ nav:
   - Documentation:
       Installation: documentation/installation.md
       Usage: documentation/usage.md
+  - Reference:
+      Schema: reference/schema.md
   - Contributing:
       Development: contributing/development.md

pyproject.toml

@@ -57,6 +57,7 @@ dev = [
     "pytest-dotenv",
     "pytest-timeout",
     "pytest-lazy-fixture",
+    "mkdocstrings[python]",
     "mkdocs-material",
 ]