feature: trigger doc build on release tag

.ci/pipeline/docs.yml

@@ -25,6 +25,7 @@ trigger:
     - doc/
     - .ci/pipeline/docs.yml
     - .github/Pull_Request_template.md
+    - .github/workflows/docs-release.yml
 
 pr:
   branches:

.github/scripts/doc_release.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+#===============================================================================
+# Copyright 2024 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#===============================================================================
+
+# Ensure the build directory exists
+BUILD_DIR="doc/_build/scikit-learn-intelex"
+if [ ! -d "$BUILD_DIR" ]; then
+    echo "::error: Documentation build directory not found!"
+    exit 1
+fi
+
+# Copy built documentation to a temp location
+DEPLOY_DIR="/tmp/gh-pages-deploy"
+mkdir -p "$DEPLOY_DIR"
+cp -R "$BUILD_DIR"/* "$DEPLOY_DIR"
+ls $DEPLOY_DIR
+
+# Checkout gh-pages branch
+if ! git checkout gh-pages; then
+    echo "::error:: Could not checkout gh-pages branch!"
+    exit 1
+fi
+
+# Move the new versioned folder to the correct location
+rm -Rf latest
+cp -R "$DEPLOY_DIR/$SHORT_DOC_VERSION" "$SHORT_DOC_VERSION"
+cp -R "$DEPLOY_DIR/$SHORT_DOC_VERSION" latest
+cp "$DEPLOY_DIR/index.html" .
+if ! diff -r "$SHORT_DOC_VERSION" latest > /dev/null; then
+    echo "::error: Content mismatch between $SHORT_DOC_VERSION and latest directories"
+    echo "Differences found:"
+    diff -r "$SHORT_DOC_VERSION" latest
+    exit 1
+fi
+
+# Generate versions.json by scanning for year.month folders
+rm -f doc/versions.json
+mkdir -p doc
+echo "[" > doc/versions.json
+# Add latest entry first
+echo '  {"name": "latest", "version": "'$SHORT_DOC_VERSION'", "url": "/scikit-learn-intelex/latest/"},' >> doc/versions.json
+# Add all year.month folders
+for version in $(ls -d [0-9][0-9][0-9][0-9].[0-9]* 2>/dev/null || true); do
+  echo '  {"name": "'$version'", "version": "'$version'", "url": "/scikit-learn-intelex/'$version'/"},'
+done | sort -rV >> doc/versions.json
+# Remove trailing comma and close array
+sed -i '$ s/,$//' doc/versions.json
+echo "]" >> doc/versions.json
+cat doc/versions.json
+
+# Commit and push changes
+git add -A "$SHORT_DOC_VERSION"
+git add -A latest
+git add doc/versions.json
+git add index.html
+git commit . -m "Automatic doc update for version $DOC_VERSION"
+git push origin gh-pages

.github/workflows/docs-release.yml

@@ -0,0 +1,93 @@
+#===============================================================================
+# Copyright 2024 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#===============================================================================
+name: Docs Release
+
+on:
+  push:
+    tags:
+      - '[0-9][0-9][0-9][0-9]\.[0-9][0-9]?\.[0-9]' # Trigger on tag pushes
+
+permissions:
+  contents: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-24.04
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Ensures all tags are fetched
+
+    - name: Set Up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
+
+    - name: Install System Dependencies
+      run: sudo apt-get update && sudo apt-get install -y clang-format pandoc
+
+    - name: Extract Tag Version
+      run: |
+        export DOC_VERSION="${GITHUB_REF#refs/tags/}"
+        # Error out if cannot find version
+        if [ -z "$DOC_VERSION" ]; then
+          echo "::error: Failed to determine documentation version."
+          exit 1
+        fi
+        export SHORT_DOC_VERSION=$(echo "$DOC_VERSION" | awk -F'.' '{print $1"."$2}')
+        # export env var in other files
+        echo "DOC_VERSION=$DOC_VERSION" >> $GITHUB_ENV
+        echo "SHORT_DOC_VERSION=$SHORT_DOC_VERSION" >> $GITHUB_ENV
+    - name: Checkout release branch
+      run: |
+        if git checkout $DOC_VERSION 2>/dev/null; then
+          echo "Successfully checked out tag $DOC_VERSION."
+        else
+            echo "::error:: Tag $DOC_VERSION does not exist."
+            exit 1
+        fi
+        git branch
+    - name: Install Python Dependencies
+      run: |
+        pip install daal-devel impi-devel
+        pip install -r dependencies-dev
+        pip install -r requirements-doc.txt
+    - name: Build daal4py/sklearnex
+      run: |
+        export DALROOT=$(dirname $(dirname $(which python)))
+        export LD_LIBRARY_PATH=$(dirname $(dirname $(which python)))/lib:$LD_LIBRARY_PATH
+        ./conda-recipe/build.sh
+    - name: Build scikit-learn-intelex Documentation
+      run: |
+        export LD_LIBRARY_PATH=$(dirname $(dirname $(which python)))/lib:$LD_LIBRARY_PATH
+        cd doc
+        ./build-doc.sh --gh-pages
+    - name: Deploy Documentation to gh-pages
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        # Copy the script to a temp location
+        # Otherwise it will get lost after switch branch
+        cp .github/scripts/doc_release.sh /tmp/doc_release.sh
+
+        # Set git auth for push changes 
+        git config --global user.name "GitHub Actions"
+        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+        chmod +x /tmp/doc_release.sh
+        /tmp/doc_release.sh

doc/build-doc.sh

@@ -49,7 +49,6 @@ if [[ "$*" == *"--gh-pages"* ]]; then
     export SOURCEDIR=sources
 
     sphinx-build -b html $SOURCEDIR $BUILDDIR/$SPHINXPROJ/$DOC_VERSION
-    cp versions.json $BUILDDIR/$SPHINXPROJ
     echo "<meta http-equiv=\"refresh\" content=\"0; URL='/$SPHINXPROJ/$DOC_VERSION/'\" / >" >> $BUILDDIR/$SPHINXPROJ/index.html
 else
     make html

doc/sources/_static/version_switcher.js

@@ -1,43 +1,43 @@
-# Copyright contributors to the oneDAL project
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-function load_versions(json){
+// Copyright contributors to the oneDAL project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+function load_versions(json) {
     var button = document.getElementById('version-switcher-button')
     var container = document.getElementById('version-switcher-dropdown')
     var loc = window.location.href;
     var s = document.createElement('select');
     s.style = "border-radius:5px;"
     const versions = JSON.parse(json);
-    for (entry of versions){
+    for (entry of versions) {
         var o = document.createElement('option');
         var optionText = '';
-        if ('name' in entry){
+        if ('name' in entry) {
             optionText = entry.name;
-        }else{
+        } else {
             optionText = entry.version;
         }
         o.value = entry.url;
-        if (current_version == entry.version){
+        if (current_version == entry.version) {
             o.selected = true;
         }
         o.innerHTML = optionText;
         s.append(o);
     }
-    s.addEventListener("change", ()=> {
+    s.addEventListener("change", () => {
         var current_url = new URL(window.location.href);
         var path = current_url.pathname;
         //strip version from path
-        var page_path = path.substring(project_name.length+current_version.length+3);
+        var page_path = path.substring(project_name.length + current_version.length + 3);
         window.location.href = s.value + page_path;
     });
     container.append(s);

doc/sources/_templates/layout.html

@@ -1,23 +1,25 @@
 {% extends "!layout.html" %}
 {% block extrahead %}
-    <script defer type="text/javascript" src="https://www.intel.com/content/dam/www/global/wap/performance-config.js" ></script>
-    <script type="text/javascript">
-        fetch("{{ switcher_url }}").then(response => response.text()).then(respText=> load_versions(respText));
-        // Configure TMS settings
-        var wapLocalCode = 'us-en'; // Dynamically set per localized site, see mapping table for values
-        var wapSection = "scikit-learn"; // WAP team will give you a unique section for your site
-        // Load TMS
-        if(document.location.href.includes("uxlfoundation.github.io/scikit-learn-intelex")){
-          (function () {
-            var url = 'https://www.intel.com/content/dam/www/global/wap/tms-loader.js'; // WAP file URL
-            var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; po.src = url;
-            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
-          })();
-      }
-      </script>
+<script defer type="text/javascript"
+  src="https://www.intel.com/content/dam/www/global/wap/performance-config.js"></script>
+<script type="text/javascript">
+  fetch("{{ switcher_url }}").then(response => response.text()).then(respText => load_versions(respText));
+  // Configure TMS settings
+  var wapLocalCode = 'us-en'; // Dynamically set per localized site, see mapping table for values
+  var wapSection = "scikit-learn"; // WAP team will give you a unique section for your site
+  // Load TMS
+  if (document.location.href.includes("uxlfoundation.github.io/scikit-learn-intelex")) {
+    (function () {
+      var url = 'https://www.intel.com/content/dam/www/global/wap/tms-loader.js'; // WAP file URL
+      var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; po.src = url;
+      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
+    })();
+  }
+</script>
 {% endblock %}
 
 {% block menu %}
-  {% include "versions.html" %}
-  {{ super() }}
+{% include "versions.html" %}
+{{ super() }}
 {% endblock %}
+

doc/sources/conf.py

@@ -29,7 +29,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
+import os
 import sys
 
 # sys.path.insert(0, os.path.abspath("../"))
@@ -44,10 +44,8 @@
 # The short X.Y version
 # Note: it should not have more than  two parts (year.month), otherwise the
 # version switcher will not be able to pick it.
-version = "2025.2"
-# The full version, including alpha/beta/rc tags
-release = "2025.2"
-
+version = os.environ.get("SHORT_DOC_VERSION", "latest")
+release = version
 
 # -- General configuration ---------------------------------------------------
 
@@ -155,12 +153,11 @@
     "titles_only": False,
 }
 
-switcher_url = "/scikit-learn-intelex/versions.json"
 
 html_context = {
     "current_version": version,
     "project_name": "scikit-learn-intelex",
-    "switcher_url": switcher_url,
+    "switcher_url": "/scikit-learn-intelex/doc/versions.json",
 }
 
 

doc/versions.json

@@ -1,38 +1,8 @@
 [
     {
         "name": "latest",
-        "version": "2025.2",
+        "version": "latest",
         "url": "/scikit-learn-intelex/latest/"
-    },
-    {
-        "name": "2025.2",
-        "version": "2025.2",
-        "url": "/scikit-learn-intelex/2025.2/"
-    },
-    {
-        "name": "2025.1",
-        "version": "2025.1",
-        "url": "/scikit-learn-intelex/2025.1/"
-    },
-    {
-        "name": "2025.0",
-        "version": "2025.0",
-        "url": "/scikit-learn-intelex/2025.0/"
-    },
-    {
-        "version": "2024.7",
-        "url": "/scikit-learn-intelex/2024.7/"
-    },
-    {
-        "version": "2024.6",
-        "url": "/scikit-learn-intelex/2024.6/"
-    },
-    {
-        "version": "2024.3",
-        "url": "/scikit-learn-intelex/2024.3/"
-    },
-    {
-        "version": "2023.2",
-        "url": "/scikit-learn-intelex/2023.2/"
     }
 ]
+