Merge pull request #7 from aai-institute/feature/workflow-docs

Feature/workflow docs

.github/workflows/code-quality.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.12"
+          python-version: "3.11"
 
       - name: Run pre-commits
         uses: pre-commit/[email protected]

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11"]
 
     timeout-minutes: 20
 
@@ -49,7 +49,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["macos-latest"]
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11"]
 
     timeout-minutes: 20
 
@@ -85,10 +85,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Set up Python 3.10
+      - name: Set up Python 3.11
         uses: actions/setup-python@v2
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
       - name: Install dependencies
         run: |

README.md

@@ -1,9 +1,18 @@
 <div align="center">
 
-<img alt="Continuity" src="https://raw.githubusercontent.com/aai-institute/Continuity/main/docs/img/logo.png">
+<img alt="Continuity" src="https://aai-institute.github.io/Continuity/img/logo.png" width="200">
 
 Mapping continuous functions with neural networks.
 
+<a href="https://pytorch.org/get-started/locally/">
+  <img alt="PyTorch" src="https://img.shields.io/badge/PyTorch-ee4c2c?logo=pytorch&logoColor=white">
+</a>
+<a href="https://aai-institute.github.io/Continuity/">
+  <img alt="Documentation" src="https://img.shields.io/badge/Documentation-blue">
+</a>
+<a href="https://github.com/aai-institute/Continuity/actions/workflows/test.yml">
+  <img alt="Test" src="https://github.com/aai-institute/Continuity/actions/workflows/test.yml/badge.svg">
+</a>
 </div>
 
 # Description