Merge pull request #3 from VH-Lab/ci-docs-setup-13537202722892185221

Add CI/CD workflows and update docs config

Author: stevevanhooser

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+
+    - name: Run tests
+      run: |
+        python -m unittest discover -s tests

.github/workflows/deploy-docs.yml

@@ -0,0 +1,27 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Install dependencies
+        run: |
+          pip install .
+      - name: Configure Git User
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+      - name: Deploy
+        run: mkdocs gh-deploy --force

.gitignore

@@ -71,3 +71,4 @@ example/binary_collections/*
 
 # symlinked schema
 */.ndi
+site/

DID-python

@@ -1,4 +1,6 @@
 site_name: NDI-python
+theme:
+  name: material
 nav:
     - Home: index.md
     - Cache: cache.md

NDI-compress-python

@@ -19,6 +19,7 @@ classifiers = [
 dependencies = [
     "did @ git+https://github.com/VH-Lab/DID-python.git@main",
     "mkdocs",
+    "mkdocs-material",
     "pandas",
     "requests",
     "ndi-compress @ git+https://github.com/Waltham-Data-Science/NDI-compress-python",