docs: add versioning using mike (#102)

* initial changes

* fix to override, adapting ci

Author: andreatgretel

.github/workflows/build-docs.yml

@@ -1,11 +1,8 @@
 name: Build docs
 on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-    paths:
-      - 'docs/**'
+  release:
+    types:
+      - published
 
 jobs:
   build-notebooks:
@@ -32,5 +29,11 @@ jobs:
         with:
           name: notebooks
           path: docs/notebooks
+      - name: Extract version from release
+        run: |
+          # Remove the 'v' prefix and any suffix after a space
+          VERSION=$(echo ${{ github.event.release.tag_name }} | sed 's/^v//' | sed 's/ .*$//')
+          echo "::notice::Extracted version: $VERSION"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
       - name: Build and deploy docs
-        run: uv run mkdocs gh-deploy --force --clean --verbose
+        run: uv run mike deploy --push --update-aliases ${{ env.VERSION }} latest

docs/overrides/main.html

@@ -1,5 +1,12 @@
 {% extends "base.html" %}
 
+{% block outdated %}
+  You're not viewing the latest version.
+  <a href="{{ '../' ~ base_url }}"> 
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}
+
 {% block content %}
 {% if page.nb_url %}
     <a href="{{ page.nb_url }}" title="Download notebook" class="md-content__button md-icon" download>

mkdocs.yml

@@ -1,4 +1,5 @@
 site_name: NeMo Data Designer
+site_url: https://nvidia-nemo.github.io/DataDesigner/
 repo_url: https://github.com/NVIDIA-NeMo/DataDesigner
 
 nav:
@@ -64,6 +65,8 @@ theme:
 extra:
   version:
     provider: mike
+    alias: true
+    default: latest
 
 watch:
   - src/data_designer