Merge branch 'main' into fix-testcases

Author: rofrano

.github/workflows/mkdocs-deploy.yml

@@ -0,0 +1,34 @@
+name: mkdocs-deploy 
+on:
+  push:
+    branches:
+      - master 
+      - 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@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-
+      - run: pip install mkdocs-material 
+      - run: pip install mkdocs-autorefs
+      - run: pip install mkdocs-get-deps
+      - run: pip install mkdocs-material-extensions
+      - run: pip install mkdocstrings
+      - run: pip install mkdocstrings-python
+      - run: mkdocs gh-deploy --force --verbose

mkdocs.yaml

@@ -42,11 +42,11 @@ theme:
   palette:
     - primary: custom
 nav:
-  - Home: docs/README.md
-  - Walkthrough: docs/walkthrough.md
-  - API Reference: docs/api_reference.md
-  - Publications: docs/publications.md
-  - Contribute: docs/contribute.md
+  - Home: README.md
+  - Walkthrough: walkthrough.md
+  - API Reference: api_reference.md
+  - Publications: publications.md
+  - Contribute: contribute.md
 
 # Define some IBM colors
 extra_css: