publish docs

.github/workflows/publish-docs.yml

@@ -0,0 +1,38 @@
+name: publish-docs
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    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 .[docs]
+
+      - run: mkdocs gh-deploy --force

README.md

@@ -17,7 +17,7 @@ This package provides atomic versions of common data structures:
 - `AtomicRef`
 - …and more to come
 
-[Visit the docs for more information.](http://dpdani.github.io/cereggii)
+[Visit the docs for more information.](https://dpdani.github.io/cereggii)
 
 
 ## Cereus greggii

mkdocs.yml

@@ -1,4 +1,9 @@
 site_name: cereggii
+repo_url: https://github.com/dpdani/cereggii
+site_url: https://dpdani.github.io/cereggii/
+
+copyright: |
+  © 2023- Daniele Parmeggiani
 
 nav:
   - 'index.md'
@@ -22,8 +27,6 @@ nav:
   - 'News':
       - 'blog/index.md'
 
-repo_url: https://github.com/dpdani/cereggii
-
 theme:
   name: material
   icon:
@@ -87,8 +90,10 @@ extra:
       link: https://github.com/dpdani/cereggii
     - icon: material/license
       link: https://github.com/dpdani/cereggii/blob/main/LICENSE
-  version:
-    provider: mike
+#  version:
+#    provider: mike
+#    default: stable
+#    alias: true
 
 plugins:
   - search
@@ -109,8 +114,5 @@ extra_javascript:
   - js/mathjax.js
   - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
 
-copyright: |
-  © 2023- Daniele Parmeggiani
-
 watch:
   - ./src/cereggii/_cereggii.pyi