ci: Try mike for versions

Author: adinhodovic

.github/workflows/docs.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+  release:
+    types:
+      - published
 
 permissions:
   contents: write
@@ -27,5 +30,21 @@ jobs:
       - name: Install docs dependencies
         run: uv sync --extra docs
 
-      - name: Deploy docs
-        run: uv run mkdocs gh-deploy --force --strict
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Fetch gh-pages branch
+        run: git fetch origin gh-pages --depth=1 || true
+
+      - name: Deploy dev docs (on push to main)
+        if: github.event_name == 'push'
+        run: uv run mike deploy --push dev
+
+      - name: Deploy versioned docs (on release)
+        if: github.event_name == 'release'
+        run: |
+          VERSION="${{ github.event.release.tag_name }}"
+          uv run mike deploy --push --update-aliases "$VERSION" latest
+          uv run mike set-default --push latest

mkdocs.yml

@@ -3,6 +3,7 @@ site_description: OpenTelemetry observability for Django with traces, logs, metr
 site_url: https://adinhodovic.github.io/django-o11y/
 repo_url: https://github.com/adinhodovic/django-o11y
 repo_name: adinhodovic/django-o11y
+edit_uri: edit/main/docs/
 
 theme:
   name: material
@@ -24,13 +25,33 @@ theme:
     - navigation.sections
     - navigation.top
     - navigation.expand
+    - navigation.footer
+    - navigation.indexes
     - search.highlight
     - search.suggest
+    - search.share
     - content.code.copy
     - content.code.annotate
+    - content.action.edit
+    - content.action.view
+    - content.action.edit
+    - content.action.view
+
+extra:
+  version:
+    provider: mike
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/adinhodovic/django-o11y
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/django-o11y/
 
 plugins:
   - search
+  - mike:
+      alias_type: symlink
+      canonical_version: null
+      version_selector: true
 
 markdown_extensions:
   - admonition

pyproject.toml

@@ -78,7 +78,7 @@ dev-logging = ["rich>=13.0.0"]
 all = ["django-o11y[celery,profiling,postgres,redis,http,dev-logging]"]
 
 # Documentation
-docs = ["mkdocs>=1.6,<2.0", "mkdocs-material>=9.5.0"]
+docs = ["mkdocs>=1.6,<2.0", "mkdocs-material>=9.5.0", "mike>=2.0.0"]
 
 # Development dependencies
 dev = [