feat: docs page now shows SDK version

.github/workflows/docs.yaml

@@ -39,7 +39,7 @@ jobs:
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs
+          publish_dir: ./publish
           # this puts the docs for this tag under gh-pages:/rc/<tag>/
           destination_dir: rc/${{ github.event.release.tag_name }}
 
@@ -48,4 +48,4 @@ jobs:
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs
+          publish_dir: ./publish

.gitignore

@@ -8,4 +8,4 @@ __pycache__/
 .vscode/
 tests/__pycache__/
 dist/
-docs/
+publish/

Makefile

@@ -23,7 +23,13 @@ fmt: install dev # run code formatter
 	uv run ruff format kratix_sdk tests
 
 generate-docs: install dev # create API documentation
-	uv run pdoc src/kratix_sdk -o docs
+	VERSION=$(shell python3 -c 'import json; print(*json.load(open(".release-please-manifest.json")).values(), end="")') \
+	uv run pdoc src/kratix_sdk \
+	--output-directory publish \
+	--template-directory docs/templates \
+	--logo logo.svg \
+	--favicon favicon.ico
+	cp -r docs/assets/* publish/
 
 build-and-load-configure-image: # build example docker image and load it into kind
 	docker buildx build --builder kratix-image-builder --load --platform linux/arm64 \

docs/templates/module.html.jinja2

@@ -0,0 +1,7 @@
+{% extends "default/module.html.jinja2" %}
+{% block nav_footer %}
+    <footer>{{ module.modulename }} v{{ env["VERSION"] | default("snapshot") }}</footer>
+{% endblock %}
+{% block module_info %}
+    <h1 class="modulename">{{ module.modulename }} v{{ env["VERSION"] | default("dev") }}</h1>
+{% endblock %}