Add docs workflow (#195)

* Added docs workflow

* Add develop push trigger

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: docs
+# Based on https://squidfunk.github.io/mkdocs-material/publishing-your-site/
+on:
+  push:
+    branches:
+      - main
+      - develop # TODO remove once we have the first version of the docs up.
+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 -r requirements.docs.txt
+      - run: mkdocs gh-deploy --force

.vscode/settings.json

@@ -5,7 +5,7 @@
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.organizeImports": "explicit"
     }
   },
   "isort.args": [