diff --git a/.github/workflows/deploy-doc.yml b/.github/workflows/deploy-doc.yml index 9bc3e06..eaac39e 100644 --- a/.github/workflows/deploy-doc.yml +++ b/.github/workflows/deploy-doc.yml @@ -41,4 +41,5 @@ jobs: - run: | source .venv/bin/activate + helm-mkdocs chart -o docs/helm-chart mkdocs gh-deploy --force diff --git a/mkdocs.yml b/mkdocs.yml index 383f27b..d8a6180 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,3 +68,4 @@ nav: - Getting Started: user-guide/getting_started.md - Examples: user-guide/examples.md - Code Reference: reference/ + - Helm Chart: helm-chart/ diff --git a/poetry.lock b/poetry.lock index f523756..e26c019 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2011,6 +2011,20 @@ files = [ {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"}, ] +[[package]] +name = "helm-mkdocs" +version = "0.0.5" +description = "Generate mkdocs style documentation for a helm chart." +optional = false +python-versions = ">3.7" +files = [ + {file = "helm_mkdocs-0.0.5-py3-none-any.whl", hash = "sha256:d519141b664a37d40ec5e3416e94e4e10f9fea94a719c840657af6f622e2271b"}, + {file = "helm_mkdocs-0.0.5.tar.gz", hash = "sha256:b5f694b593a2f7f0dcf79e29a1480349b80654dc24eb523d1c5bc7f37dfff60d"}, +] + +[package.dependencies] +pyyaml = "*" + [[package]] name = "httpcore" version = "1.0.2" @@ -4811,4 +4825,4 @@ api = ["aiohttp", "fastapi", "httpx", "jinja2", "kubernetes-asyncio", "uvicorn", [metadata] lock-version = "2.0" python-versions = "^3.8" -content-hash = "ba408894774625a70413959f6fb9ac8888aff80393767939f3a9ac4c5d067290" +content-hash = "c933ed7a8421960387a687f25fbe69fabe23650aef65eac36090de0a8d5986b4" diff --git a/pyproject.toml b/pyproject.toml index bade222..9cdc0b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ mkdocs-material = "^9.5.21" mkdocstrings = {version = "^0.25.1", extras = ["python"]} mkdocs-gen-files = "^0.5.0" mkdocs-literate-nav = "^0.6.1" +helm-mkdocs = "^0.0.5" [tool.poetry.extras] api = ["fastapi", "kubernetes-asyncio", "uvicorn", "httpx", "jinja2", "aiohttp", "websockets"]