From aa9a3307bff555a2f57fc5e650d7cd3e41368132 Mon Sep 17 00:00:00 2001 From: John Mikos Date: Tue, 9 Dec 2025 16:35:24 +0000 Subject: [PATCH 1/2] feat: docs page now shows SDK version Co-authored-by: Shane Dowling --- .github/workflows/docs.yaml | 4 ++-- .gitignore | 2 +- Makefile | 9 ++++++++- docs/assets/favicon.ico | Bin 0 -> 15406 bytes docs/assets/logo.svg | 3 +++ docs/templates/module.html.jinja2 | 7 +++++++ 6 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 docs/assets/favicon.ico create mode 100644 docs/assets/logo.svg create mode 100644 docs/templates/module.html.jinja2 diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 999d000..5850b69 100644 --- a/.github/workflows/docs.yaml +++ b/.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// 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 diff --git a/.gitignore b/.gitignore index e061bf7..a35dc10 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,4 @@ __pycache__/ .vscode/ tests/__pycache__/ dist/ -docs/ +publish/ diff --git a/Makefile b/Makefile index 87024ef..e039b2a 100644 --- a/Makefile +++ b/Makefile @@ -23,7 +23,14 @@ 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 \ diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..32c3698bfd52947930c967ad6d7d3372fba114de GIT binary patch literal 15406 zcmeI32bfh=lE>eEvlDlM?yS4+gk5$gxjQm2Di~4J86{^VOBfp%X>ub;C5S{pa!vx$ zl9Qw+DNT~pl5=XJWZsC$vTk9zRQT}|*~+0)^S@q{ z&zG%{MdN15*thyc>XcHRODBG8?_)dkmyL^8N$KzZK2lEGO8@$l9N4m3y4QNczJD@# zex$t24<3;-$4*Mu>M61}W4nxM+ea3SpC!e={X45u<_C|;XLCQ1&Xt?W%2`X~y?X6r z(FZf5+QajULq}!F#5vOV@mGw`wD-qKiSHDUWs~Mfo0tA%^*feNHaRLi@MKi`1*50Q z>yK5G^QX>Qdt@Hos;BH+yG6RyY-M#T|J&0#J}abVz852HsfYZu=XrGd_f1Clj(xko zWL?jap0(RZ*&jYCt3O^Q^$V1ZYU^)5v}Jdh(tC`2GHJf`k+IEKx<)oGT`et(zM8FV zP<#3ho%y4t>KNvi4U1OF))gBhS-(@?|L2vTcC@F?l=nu<@dHO}EGzu@aqD~C-xN={ zJ!>-UgBj96#~gaqfBwA6vP!D{^w}sH@LxVEX|5wgjBF&$zX>FLlUF)_; zx%&%8Xwd%r$+Ob;&mHC9_PtTu z*RMZXF;Yf*{;K};IXS%RfOM;oV(;GdOL>~E$0_fPk+ln!$J~Q;A1a~y=QEi(aDt?E z8y3Zb^^#n;vXs$v;&=w#E9$!a^CK0c*tf!R1uBJHd_>RW)4!tnhklB61)iKSaLBVo4(n1&P{A`oB>&k^o@>c1FIkt->$Am6J zN$9hd9$y) z`innG--aFJ=9f36$E#so?Uw-?bN$LS=~<^ugja=sc|x+TU6%`|&q>n5r6b?{ZT;`q z1Nyz`)3s4;mgs(5qdMPTpLcXOSF0E6M#_upemMKZX}O{L_Qb)XQsY0LkCX+`;9Hww zugQ(9Ecx=r4OyBxH>&=mo+D-J$_-K99397ho=1nYRa#u=5A?*oO*^Hcj)`mIzc(se zNmw)3gwZ8jz9c1sNKU>Ueo#D>aRMm&aaEfnd2wT zR+s+%BiU%U^6jfXm$E-9q;fu~dj7E5&to!IeSplJ`{nZaixQ;k>4)QwF6E*w>ldEz zr%t0n;r^i~OWd*Je6RA8XXWtj1IFW(2cL<^R_nk2Ad7X*Z{56UbJ+T&dXX~!*g5_! zbgeT7UuNBqb|veZ{dfFn)Ar@?{Lbh<-e{G(udwXUJ$w4t7g9UG2O8C`kFCY7cXYg; zuX}g=n?F-SN`AM1teU-4u3ow#*Dha;^xxI(UaOVT)V-zag7IRkg6vDLy6xn))*ITQ zd(3`2nqK~VEBm9zWZS9?n~MRjcgoftKZc9F5j3uEmTI7T;7gg@YgD$jj;HtT=T8}P zdFk8*IlA|dRQ=g=QFKzf4>$hov-Tw$M3psuvWkt};_EEc6@kX}mSFandCQnqcvU>khLeA;FTdzJ{seg+0S7Y(!dp!QL2dCN` zuTNVc)pQ)LUA`hy`;4)5Qdxaq=83)D;<;LKbYEtatnqky%i{58{bLhuT+6aOhEB$R zcJ14hsBhzez7Lu!S1;Z@C;qg3w^~cvOW356-~B2kX{GksU3)fci_B9ze*UsV_|pbI zk84Eh_pJZKBNB2Ezc6=m58XuhQ+HC2ktV|-)#s;=exYmdnzYwBpseZB z)l6qBo{;$3&n%42K?n0c648CM%`Jc05HIXpyIFPrNvZv-m$S(*uH!&kug<^s%jkW-8~(JfqH)iW z-3KLe*M52Bj;(ieiIuRuv2?Vn$KCNCmeNC(eKgO;c3|Uo!P&<(`K zdop&I-ejGili4fPe_k{qpO=Q~fBLjEjqk%40WmsPBK)D%R%5{%>NgO#4{G|Z^|{V( ziWxuV249Hr@bY!fjz9i|`^NlTQ0yR4{emsVTF zI_XlSd8C}U5&r|d>#dv9^N2Tk*|>rGcwU+c>`}Y53~JKFus3g6uAg=N5YM0k@sZHmxu&6O_-mwFM)B`%8k2pbe%Y9}`xz#R?*2OaLM+m?dQ0Uw zLgT>xhVy|}V))$9OSEpoN6IS>veERc9RdokZ_odOH~}y@*j>Q%o() z^9jSPh^z278ved~j`HIpfz6yfaZ0hdQc?AZ4T)J9Bm9RU&AXYuo~WEb^@w}Z)qX;g zxVuAzUqii1`P^FW^VsGM@2$Swmd-_uXp-33x$wfhL;LD}*t3pBU)f_$oXXzy6_xilz{b1ne;(Z5k=n>XYqhX(FSAD~0t6Tcju z>|!gMa}Jf1_sv3u8SkP5s!&vyYGM&y%jjJ9*s-cks<1dHvtK@`KZ+yiiBi&I!{G zX_`A2)U-=B`JsW&(Ntx;aORxN`SgC{A~~trzk12=Mb`IPjUByMzMp@6-Dl1YFQ2+F zTmIKy-~aBHpLqu_cXph71^Uywe!Mi=l}J+CcUt$N=4Uh~pOn9}`XXCxZIR>g=kvX7 znG9qu}RTF+T1 z_8-eWu#dq-!Id(1?vvy~l>_Mp@$!F*B|r7xGk5qT^DnTw;Gqsv^3oyJpFUu`6JIWA z9;d}~HKXj3tB>9!ABIljTnqW>Saams#Jk6npLSvW6VCq~&^6Kg+2|ZF@{nW1zw=(? z;ZmNj9VHub4sPDnYz*s-eMX)=o_sl#K8po`@;eY(!<8|P$LgV@&bod?;T$!Tm8DNj^>&fqkAy1E?Ly4!5SiW!SdM=|c; zec+y6e$6%iN-m3Q^YV3O>zI>SdUgTbAv$t(-jM9nb1_bjGxnUTqwMJ3OpPTu+A>AaC+NZ0AvlD_I-vLjQB-vyJ9pyyMKAP3!xC z*;-JrYZ?p0l7+fku;*GA zY@>$uDOTNh-|waT>_^VW9@qFE-xv%v9uC_;&l_{5nm(-6KE#XDV)fx(%I|ozR2&H% z!!>(IYPPuD)#J{&U9bb}IKD-0?XzG0T6)HjJ=I8KigNcCGCSpu-@W`}J$F*S9{UBZ zfN#ec$e_CDCom!82e+N@&ftV_6GzL*4;}^H$lQbFVlTI?+GueSXPaWhkB*N2PVW8v z25*~f11}^-@SlSsH$SRvZ#lB(psgY13;&cj+MUn$)AheQ`Dx3AtY`HM0=_O7mAi5) zKYWPQ#&;g9GG$pmy47eEiOKLmCaCR0Ux77o?g7l4eZ$#H^36f9UOf3vs4qVt`5lY9 zS(oG#90qqc^23WUPwhI)umHw{^M_y@T{NGKonwu0)&t+1bEcdVp--GK<-D$6UjMrr zf9B0%QBQ8U+RuubZetGaR(|+l8|DoCNNy_TeCo&v&5JZvygS3z3g-{KXTZv9%)N5v zV(SCgqhDVCyOW<-ue$z*AgWyT;qX?y%ty|P{Lmz~ux>%Rt#jfU))ajS!cD;ERi(-- z^-H4UQ9Ay2@*%8qemfI{#o{Y6H=KF)x6SQ4xG6X#c9#nuh~FLf=`?w&s`Zn2$6w}u zFZsO!7Duu6>-f%2vBx+&hJBgn`%QzNPNMJFU3Z?9-{Z7-IsDrlZ~K9I=7Q^kP6Kk3 zpLXD{OxO&?aIlx`FZLZd3V!2)PZsO za0W0Dn&dL^1<_sjBH&B(1=+DHJjcS)5~1&}gP*}U6!J&JpX4Cn2?k8R;JIMTG~M^% zbGH8W{&#F(=Soc@HlO{#{((-K=7NLvg`Y-l-|0hZ{oNP#k}J$JyfN4#iRey0PjK%^ znhWN4U|`wkYGMw5y?gmi?tG%!2Y$n}eA+_krN4h;Pv(usZ}ZqbyPnINJpVuF>G7by MUwkR0C0EsSO5S3 literal 0 HcmV?d00001 diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..96c5a6a --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/templates/module.html.jinja2 b/docs/templates/module.html.jinja2 new file mode 100644 index 0000000..364a5a4 --- /dev/null +++ b/docs/templates/module.html.jinja2 @@ -0,0 +1,7 @@ +{% extends "default/module.html.jinja2" %} +{% block nav_footer %} +
{{ module.modulename }} v{{ env["VERSION"] | default("snapshot") }}
+{% endblock %} +{% block module_info %} +

{{ module.modulename }} v{{ env["VERSION"] | default("dev") }}

+{% endblock %} \ No newline at end of file From 8c610433131750a626f112e44b29c7200b18397d Mon Sep 17 00:00:00 2001 From: John Mikos Date: Tue, 9 Dec 2025 16:37:20 +0000 Subject: [PATCH 2/2] chore: removed unneeded newline Co-authored-by: Shane Dowling --- Makefile | 1 - 1 file changed, 1 deletion(-) diff --git a/Makefile b/Makefile index e039b2a..833c240 100644 --- a/Makefile +++ b/Makefile @@ -31,7 +31,6 @@ generate-docs: install dev # create API documentation --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 \ -t ghcr.io/syntasso/example-deployment-configure:v0.0.1 -f examples/deployment/Dockerfile .