Merge pull request #34 from switchbox-data/24-create-docs

Make model docs

Author: alxsmith

.devcontainer/devcontainer.json

@@ -8,6 +8,12 @@
         // Install just
         "ghcr.io/guiyomh/features/just:0.1.0": {
             "version": "1.40.0"
+        },
+        "ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {
+            "installChromium": true
+        },
+        "ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
+            "packages": "chromium"
         }},
 
     // Use 'postCreateCommand' to run commands after the container is created.

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+
+      - name: Install Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Install dev dependencies
+        run: uv sync --group dev --group docs
+
+      - name: Build documentation
+        run: uv run mkdocs build --strict
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/main.yml

@@ -67,5 +67,25 @@ jobs:
       - name: Set up the environment
         uses: ./.github/actions/setup-python-env
 
+      - name: Install docs dependencies
+        run: uv sync --group docs
+
       - name: Check if documentation can be built
         run: uv run mkdocs build -s
+
+
+  deploy-docs:
+    needs: check-docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+
+      - name: Install docs dependencies
+        run: uv sync --group docs
+
+      - name: Deploy documentation
+        run: uv run mkdocs gh-deploy --force

.gitignore

@@ -211,3 +211,13 @@ marimo/_lsp/
 __marimo__/
 .vscode/launch.json
 .DS_Store
+
+outputs/
+/.quarto/
+*.html
+.DS_Store
+*_files/
+
+# Explicitly include everything in docs directory
+!docs/
+!docs/**/*