docs(helm): add helm chart doc to the gh page (#59)

hussein-awala · May 5, 2024 · 14d7fba · 14d7fba
1 parent 3ea2c4f
commit 14d7fba
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git 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
@@ -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
diff --git 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"]