Merge pull request #2 from bdpedigo/doc-overhaul

Doc overhaul

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 5.11.0
+current_version = 5.14.0
 commit = True
 tag = True
 

.github/workflows/daily.yml

@@ -0,0 +1,8 @@
+name: build status
+on:
+  schedule:
+    - cron: "8 15 * * *" # 7:08am PST
+  workflow_dispatch:
+jobs:
+  build:
+    uses: ./.github/workflows/dev.yml

.github/annotationframeworkclient.yml → .github/workflows/dev.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: CAVE Client
+name: Development tests
 
 on:
   push:
@@ -11,31 +11,41 @@ on:
       - "README.rst"
   pull_request:
     branches: master
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  # Allows other workflows to trigger this workflow
+  workflow_call:
 
 jobs:
   test:
     name: Test against different Python versions
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9, 3.11]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.7
+          python-version: ${{ matrix.python-version }}
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/test_requirements.txt') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('**/test_requirements.txt') }}
           restore-keys: |
-            ${{ runner.os }}-pip-
+            ${{ runner.os }}-${{ matrix.python-version }}-pip-
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install flake8 pytest
           pip install -r requirements.txt
-          if [ -f test_requirements.txt ]; then pip install -r test_requirements.txt; fi
+          pip install -r test_requirements.txt
 
       - name: Lint with flake8
         run: |

.github/workflows/docs.yml

@@ -0,0 +1,60 @@
+name: dev docs
+
+on:
+  # run this workflow when dev checks pass
+  push:
+    branches:
+      - master
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  # This workflow contains a single job called "docs"
+  docs:
+    name: Build and deploy (dev) docs
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.11"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Get repo
+        uses: actions/checkout@v4
+
+      - name: Get gh-pages branch
+        run: git fetch origin gh-pages --depth=1
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Update pip
+        run: python -m pip install --upgrade pip
+
+      - name: Cache for virtual environment
+        uses: actions/cache@v3
+        with:
+          path: ./.venv
+          key: venv-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('doc_requirements.txt') }}
+
+      - name: Install dependencies
+        run: pip install -r doc_requirements.txt
+
+      - name: Configure git for github-actions[bot]
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      # - name: Build and push versioned docs with mike
+      #   run: |
+      #     poetry run mike deploy --push --update-aliases dev
+      #     poetry run mike set-default stable --push
+
+      - name: Build and push docs
+        run: |
+          mkdocs gh-deploy --force --remote-branch gh-pages --remote-name origin