Set up workflow to push documentation to GitHub pages

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: docs - build, deploy
+on:
+  push:
+    branches:
+      - main
+      - develop
+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@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      # We need to install not just the doc dependencies but also the package itself
+      # since it has the docs/tools/asset_type_replacer plugin.
+      - run: python -m pip install -e ".[docs]"
+      - run: python -m mkdocs gh-deploy --force

mkdocs.yaml

@@ -6,6 +6,7 @@ theme:
     - content.code.copy
 
 nav:
+  - Home: README.md
   - Using the API: Using.md
   - Hosting the API: Hosting.md
   - 'Developer Resources':