DOC: Fix version switcher code and update URLs and logos (#2279)

* add code for doc version switcher, new UXL URLs and logos

* remove javascripts and htmls from copyright header check

* update for 'latest'

* set latest as 2025.2

* revert unneeded URL change

* remove empty line

* add copyright header for JS code

Author: david-cortes-intel

.github/.licenserc.yaml

@@ -48,11 +48,13 @@ header:
    # Something in doc/
     - 'doc/daal4py/_static/style.css'
     - 'doc/daal4py/_templates/layout.html'
-    - 'doc/sources/_static/style.css'
+    - 'doc/sources/_static/custom.css'
     - 'doc/sources/_templates/footer.html'
     - 'doc/sources/_templates/layout.html'
+    - 'doc/sources/_templates/versions.html'
     - 'doc/daal4py/third-party-programs.txt'
     - 'doc/third-party-programs-sklearnex.txt'
+    - 'doc/versions.json'
     # requirements
     - 'dependencies-dev'
     - 'requirements*.txt'

doc/build-doc.sh

@@ -29,5 +29,28 @@ rsync -a --exclude='daal4py_data_science.ipynb' examples/notebooks/*.ipynb doc/$
 
 # build the documentation
 cd doc
-export O="-W"
-make html
+export SPHINXOPTS="-W" # used by sphinx-build
+export O=${SPHINXOPTS} # makefile overrides SPHINXOPTS
+
+# Build comes in two variants:
+# - As a standalone doc (for local development and CI)
+# - As a versioned build (for the deployed docs), triggerable by
+#   passing argument '--gh-pages'.
+# In the first case, it will generate a page under '_build' with
+# an 'html' folder and a separate 'doctrees'. Only the 'html' part
+# is needed to render the docs locally.
+# In the second case, it will generate a versioned entry (year.month)
+# under '_build', with the doctrees inside that versioned folder.
+# Those are directly copyable to the 'gh-pages' branch to be deployed.
+if [[ "$*" == *"--gh-pages"* ]]; then
+    export DOC_VERSION=$(python -c "from sources.conf import version; print(version)")
+    export SPHINXPROJ=scikit-learn-intelex
+    export BUILDDIR=_build
+    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
+fi

doc/sources/_static/style.css renamed to doc/sources/_static/custom.css

@@ -121,3 +121,11 @@ div.quotation {
 
 a#wap_dns {display: none;}
 
+
+button#version-switcher-button {
+   background-color:  #2980b9;
+}
+
+div#version-switcher-dropdown {
+   display: inline;
+}

doc/sources/_static/favicon.png

@@ -0,0 +1,44 @@
+# 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){
+        var o = document.createElement('option');
+        var optionText = '';
+        if ('name' in entry){
+            optionText = entry.name;
+        }else{
+            optionText = entry.version;
+        }
+        o.value = entry.url;
+        if (current_version == entry.version){
+            o.selected = true;
+        }
+        o.innerHTML = optionText;
+        s.append(o);
+    }
+    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);
+        window.location.href = s.value + page_path;
+    });
+    container.append(s);
+}

doc/sources/_static/favicons.png

@@ -2,6 +2,7 @@
 {% 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
@@ -15,3 +16,8 @@
       }
       </script>
 {% endblock %}
+
+{% block menu %}
+  {% include "versions.html" %}
+  {{ super() }}
+{% endblock %}

doc/sources/_static/oneAPI-rgb-rev-100.png

@@ -0,0 +1,22 @@
+<div class="version-switcher__container dropdown">
+    <script>
+      current_version = "{{current_version}}"
+      project_name = "{{project_name}}"
+    </script>
+    <div id="version-switcher-button"
+      class="version-switcher__button"
+      data-bs-toggle="dropdown"
+      aria-haspopup="listbox"
+      aria-controls="version-switcher-dropdown"
+      aria-label="Version switcher list"
+      style="display:inline-block;padding-left:10px;padding-right:10px;"
+    >
+      Choose version  <!-- this text may get changed later by javascript -->
+      <span class="caret"></span>
+    </div>
+    <div id="version-switcher-dropdown"
+      class="version-switcher__menu dropdown-menu list-group-flush py-0"
+      role="listbox" aria-labelledby="{{ button_id }}">
+      <!-- dropdown will be populated by javascript on page load -->
+    </div>
+  </div>