Automatic CI Doc Build

.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: publish
+'on':
+  push:
+    branches:
+      main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: install dependencies
+      run: |
+        sudo apt update
+        sudo apt install -y pandoc git
+        pip3 install -r requirements-doc.txt
+        cd doc
+        source set_version.sh
+        echo Generating version $DOC_VERSION
+    - name: build docs
+      run: |
+        cd doc
+        source set_version.sh
+        chmod +x build-doc.sh
+        ./build-doc.sh
+        sphinx-build -b html sources _build/html
+        mv _build/html ../../$DOC_VERSION
+        rm -rf _build
+        cp versions.json ../..
+        cp index.html ../..
+    - name: deploy docs
+      run: |
+        cd doc
+        source set_version.sh
+        cd ..
+        git fetch
+        git checkout -- doc/build-doc.sh
+        git checkout gh-pages
+        rm -rf $DOC_VERSION
+        mv -f ../$DOC_VERSION .
+        mv ../versions.json .
+        mv ../index.html .
+        rm -rf doc
+        git config --global user.name "${GITHUB_ACTOR}"
+        git config --global user.email "${GITHUB_ACTOR}@github.com"
+        git add .
+        git commit -m "latest HTML output"
+        git push -f https://${GITHUB_ACTOR}:${{secrets.GITHUB_TOKEN}}@github.com/${GITHUB_REPOSITORY}.git HEAD:gh-pages
+

doc/build-doc.sh

@@ -28,5 +28,5 @@ cd ..
 cp examples/notebooks/*.ipynb doc/$SAMPLES_DIR
 
 # build the documentation
-cd doc
-make html
+# cd doc
+# make html

doc/index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; URL='https:///intel.github.io/scikit-learn-intelex/2024.3/'" />

doc/set_version.sh

@@ -0,0 +1,3 @@
+export DOC_VERSION=2024.3
+rm -f sources/doc_version.json
+echo "{\"version\":\"$DOC_VERSION\"}" >> sources/doc_version.json

doc/sources/_static/style.css → 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/version_switcher.js

@@ -0,0 +1,36 @@
+fetch("https:///intel.github.io/scikit-learn-intelex/versions.json").then(response => response.text()).then(respText=>
+    load_versions(respText));
+
+
+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;
+            optionText = optionText;
+        }
+        o.innerHTML = optionText;
+        s.append(o);
+    }
+    s.addEventListener("change", (event)=> {
+        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/_templates/layout.html

@@ -15,3 +15,8 @@
       }
       </script>
 {% endblock %}
+
+{% block menu %}
+  {% include "versions.html" %}
+  {{ super() }}
+{% endblock %}

doc/sources/_templates/versions.html

@@ -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>

doc/sources/conf.py

@@ -31,6 +31,10 @@
 #
 import os
 import sys
+import json
+
+with open('doc_version.json') as jsonFile:
+    doc_version = json.load(jsonFile)
 
 sys.path.insert(0, os.path.abspath("../"))
 
@@ -42,9 +46,9 @@
 author = "Intel"
 
 # The short X.Y version
-version = "2024.3.0"
+version = doc_version["version"]
 # The full version, including alpha/beta/rc tags
-release = "2024.3.0"
+release = version
 
 
 # -- General configuration ---------------------------------------------------
@@ -138,6 +142,10 @@
     "titles_only": False,
 }
 
+html_context = {
+    "current_version":version,
+    "project_name":"scikit-learn-intelex"
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -147,6 +155,7 @@
 
 def setup(app):
     app.add_css_file("custom.css")
+    app.add_js_file("version_switcher.js")
 
 
 # -- Options for HTMLHelp output ---------------------------------------------

doc/versions.json

@@ -0,0 +1,11 @@
+[
+    {
+        "name": "2024.3 (latest)",
+        "version": "2024.3",
+        "url": "https:///intel.github.io/scikit-learn-intelex/2024.3/"
+    },
+    {
+        "version": "2023.2",
+        "url": "https:///intel.github.io/scikit-learn-intelex/2023.2/"
+    }
+]