MAINT: Deploy 2025.5 docs

[yuejiaointel]

Description

Add a comprehensive description of proposed changes

List associated issue number(s) if exist(s): #6 (for example)

Documentation PR (if needed): #1340 (for example)

Benchmarks PR (if needed): IntelPython/scikit-learn_bench#155 (for example)

---

PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

• I have reviewed my changes thoroughly before submitting this pull request.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
• Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
• I have added a respective label(s) to PR if I have a permission for that.
• I have resolved any merge conflicts that might occur with the base branch.

Testing

• I have run it locally and tested the changes extensively.
• All CI jobs are green or I have provided justification why they aren't.
• I have extended testing suite if new functionality was introduced in this PR.

[yuejiaointel]

https://yuejiaointel.github.io/scikit-learn-intelex
example fork build

[david-cortes-intel]

@yuejiaointel Question here: why does it need to have a folder doc/ if it wasn't there before?

[david-cortes-intel]

@yuejiaointel It looks like the docs in your fork were already overwritten, but I am wondering now: it looks like the change in the location of versions.json happened due to a change in this line:

scikit-learn-intelex/doc/sources/conf.py

Line 169 in 18bfe50

"switcher_url": "/scikit-learn-intelex/doc/versions.json",

Would the version switcher still work for the older versions (meaning: shows all the available versions, including 2025.5) i the versions.json file gets moved to under doc/?

[david-cortes-intel]

Gave it a try on my fork and it looks like the version switcher doesn't work for previous versions:
https://david-cortes-intel.github.io/scikit-learn-intelex/2025.2/

So looks like we'll have to revert the location in conf.py, I'll open a PR for that.

[david-cortes-intel]

@yuejiaointel I've updated this PR with a modified version of the docs that removes doc/ from the version switcher location in conf.py. Looks like it now renders correctly and the version switcher works for all versions.

[yuejiaointel]

@yuejiaointel Question here: why does it need to have a folder doc/ if it wasn't there before?

Hi David,
yes, the reason is in conf.py we have
"switcher_url": "/scikit-learn-intelex/doc/versions.json",
and we want to keep it same location locally, now we have a local versions.json that only has latest, and it is only used for build locally. Before we don't have to put it in doc as we are doing it manually and having different locations locally and on gh-pages. But in order to automate, we need them to be same location.

[yuejiaointel]

@yuejiaointel It looks like the docs in your fork were already overwritten, but I am wondering now: it looks like the change in the location of versions.json happened due to a change in this line:

scikit-learn-intelex/doc/sources/conf.py

Line 169 in 18bfe50

"switcher_url": "/scikit-learn-intelex/doc/versions.json",

Would the version switcher still work for the older versions (meaning: shows all the available versions, including 2025.5) i the versions.json file gets moved to under doc/?

yes it would still work, as versions.json is used only for version switcher

[yuejiaointel]

@yuejiaointel I've updated this PR with a modified version of the docs that removes doc/ from the version switcher location in conf.py. Looks like it now renders correctly and the version switcher works for all versions.

Hi David,
Tho it works for gh-pages docs, changing conf.py from /scikit-learn-intelex/doc/versions.json to /scikit-learn-intelex/versions.json will make local build doc version switcher not work. As we are currently having versions.json in doc folder. I think for this PR it is still fine for minimal changes. But for automated solution I think we should still keep versions.json in doc.

[david-cortes-intel]

@yuejiaointel I've updated this PR with a modified version of the docs that removes doc/ from the version switcher location in conf.py. Looks like it now renders correctly and the version switcher works for all versions.

Hi David, Tho it works for gh-pages docs, changing conf.py from /scikit-learn-intelex/doc/versions.json to /scikit-learn-intelex/versions.json will make local build doc version switcher not work. As we are currently having versions.json in doc folder. I think for this PR it is still fine for minimal changes. But for automated solution I think we should still keep versions.json in doc.

I don't think it'd be a problem to have the version switcher not work on the local builds, because usually only one version is built.

But otherwise, perhaps it could be controlled through an environment variable, so that running the script with --gh-pages would make the path not have doc/ on it.

[david-cortes-intel]

yes it would still work, as versions.json is used only for version switcher

It actually didn't work - for example, if you roll back to this commit:

1d97fef9ca93af87c999330387584ed6fdea2019

and hard-push that to the branch from your github pages, the version switcher will show when browsing 'latest' and '2025.5', but it disappears after switching to other versions.

[david-cortes-intel]

Here I've redeployed from the rolled back commit:
https://david-cortes-intel.github.io/scikit-learn-intelex
https://github.com/david-cortes-intel/scikit-learn-intelex/tree/docs20255-v2

Version switcher shows for 2025.5 for example:

But not for 2025.2:

[yuejiaointel]

@yuejiaointel I've updated this PR with a modified version of the docs that removes doc/ from the version switcher location in conf.py. Looks like it now renders correctly and the version switcher works for all versions.

Hi David, Tho it works for gh-pages docs, changing conf.py from /scikit-learn-intelex/doc/versions.json to /scikit-learn-intelex/versions.json will make local build doc version switcher not work. As we are currently having versions.json in doc folder. I think for this PR it is still fine for minimal changes. But for automated solution I think we should still keep versions.json in doc.

I don't think it'd be a problem to have the version switcher not work on the local builds, because usually only one version is built.

But otherwise, perhaps it could be controlled through an environment variable, so that running the script with --gh-pages would make the path not have doc/ on it.

That make sense, I think current change is good, thx for all the experiments!

[yuejiaointel]

Here I've redeployed from the rolled back commit: https://david-cortes-intel.github.io/scikit-learn-intelex https://github.com/david-cortes-intel/scikit-learn-intelex/tree/docs20255-v2

Version switcher shows for 2025.5 for example:

But not for 2025.2:

You are right, that is a good catch, I can reproduce on my end as well. I think the reason is previous versions already having a get request to /scikit-learn-intelex/versions.json in the htmls hardcoded, so moving them to docs will make them unable to get the verisons.json. But latest works because we have changed the conf already so htmls are sending correct request to get verisons.json. I'll make changes in pipelkine as well to also keep versions.json outside