chore: auto generate docs page

.github/workflows/docs.yaml

@@ -0,0 +1,23 @@
+name: Update docs
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Install dependencies
+      run: python -m pip install --upgrade pip setuptools wheel
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+    - name: Generate docs
+      run: make install generate-docs
+    - uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs

Makefile

@@ -12,6 +12,9 @@ lint:
 fmt:
 	poetry run ruff format kratix_sdk tests
 
+generate-docs:
+	poetry run pdoc src/kratix_sdk -o docs
+
 build-and-load-configure-image:
 	docker buildx build --builder kratix-image-builder --load --platform linux/arm64 \
 	-t ghcr.io/syntasso/example-deployment-configure:v0.0.1 -f examples/deployment/Dockerfile .

Readme.md

@@ -2,6 +2,10 @@
 
 This SDK was implemented in line with the [Kratix SDK Contract](https://github.com/syntasso/kratix/blob/main/sdk/contract.go).
 
+## Documentation
+
+You can read library document [here](https://syntasso.github.io/kratix-python).
+
 ## Installation
 
 ```bash

pyproject.toml

@@ -19,4 +19,5 @@ PyYAML = ">=6.0.0,<7"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "8.4.1"
-ruff = "0.12.9"
+ruff = "0.12.9"
+pdoc = "^14"