doc: add documentation

Author: nicokant

docs/index.md

@@ -0,0 +1,13 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
+
+# Data Sync Scripts
+
+::: mkdocs-typer2
+    :module: datasync.main
+    :name: datasync
+    :pretty: true

mkdocs.yml

@@ -0,0 +1,15 @@
+site_name: Miljødata Data Sync
+theme:
+  name: material
+  palette:
+    primary: teal
+    accent: amber
+
+plugins:
+  - search
+  - mkdocs-typer2:
+      pretty: true
+
+watch:
+  - docs
+  - src

pyproject.toml

@@ -3,7 +3,12 @@ build-backend = "hatchling.build"
 requires = ["hatchling"]
 
 [dependency-groups]
-dev = ["deptry"]
+dev = [
+  "deptry",
+  "mkdocs>=1.6.1",
+  "mkdocs-material>=9.7.1",
+  "mkdocs-typer2>=0.1.6"
+]
 
 [project]
 authors = [{name = "ninanor", email = "niccolo.cantu@nina.no"}]

src/datasync/main.py

@@ -6,7 +6,9 @@
 
 from . import dms, ninagen, nva, pit_registering_salmon, ubw
 
-app = typer.Typer()
+app = typer.Typer(
+    help="Provide subcommands for synchronizing different resources, see subcommands"
+)
 app.add_typer(nva.app, name="nva")
 app.add_typer(ubw.app, name="ubw")
 app.add_typer(dms.app, name="dms")

src/datasync/ninagen/app.py

@@ -1,3 +1,3 @@
 import typer
 
-app = typer.Typer()
+app = typer.Typer(help="Commands to handle NINAGEN tasks")

src/datasync/nva.py

@@ -23,7 +23,7 @@
 NVA_REGION = env("NVA_REGION", default="us-east-1")
 CRISTIN_DB_PATH = env("CRISTIN_DB_PATH", default="")
 
-app = typer.Typer()
+app = typer.Typer(help="export NVA APIs to Parquet on a S3 Bucket")
 
 
 def get_funding_sources(client: RESTClient):

src/datasync/ubw.py

@@ -9,7 +9,7 @@
     log,
 )
 
-app = typer.Typer()
+app = typer.Typer(help="Export UBW APIs to Parquet in S3 bucket")
 
 UBW_BASE_URL = env("UBW_BASE_URL", default="")
 UBW_BASIC_AUTH = env("UBW_BASIC_AUTH", default="")