Docs

Author: AsafMah

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: website
+on:
+  pull_request: # TODO: only on main 
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: 3.9
+        enable-cache: true
+    - name: Install Poe
+      run: uv tool install poethepoet
+    - name: run pdoc
+      run: poe doc --ci
+    - uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

azure-kusto-data/tests/__init__.py

@@ -23,7 +23,8 @@ dev = [
     "aioresponses>=0.7.8",
     "asgiref>=3.9.1",
     "pandas>=2.3.1",
-    "ruff>=0.12.8",
+    "ruff>=0.12.9",
+    "pdoc>=15.0.4",
 ]
 
 [tool.uv.workspace]
@@ -54,6 +55,7 @@ pythonpath = ["."]
 envfile = ".env"
 
 [tool.poe.tasks]
+doc = {cmd = "uv run pdoc ./azure-kusto-data/azure ./azure-kusto-ingest/azure ${CI:+ -o ./docs}", args = { CI = { help = "Run in CI mode", type = "boolean", options = ["--ci"] } } }
 sync = "uv sync --all-packages --all-extras --dev --locked"
 build = "uv build --all-packages"
 format = "ruff format"