-
Notifications
You must be signed in to change notification settings - Fork 179
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Add docs for 2025 releases #2274
DOC: Add docs for 2025 releases #2274
Conversation
e2ba2a6
to
123c30a
Compare
Hi David, |
I am also wondering this. This seems like a lot of overhead to be added to the codebase. |
These are going to the branch
We'd like to get there eventually, but right now we don't have any automation and the docs have major usability issues. This PR fixes the most pressing issues (no docs for latest versions, broken version switcher). Automating all of this would be a much larger task. |
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)
This PR manually builds and adds doc pages for the 2024.7, 2025.0, 2025.1 releases, adding the custom version switcher from this other PR:
#2214
(Note: doc for 2024.7 underwent changes from the release branch as they were not rendering support tables correctly, and docs for 'latest' right now are a hard copy of 2025.1 - i.e. there's no redirect)
URL to preview before merging: https://david-cortes-intel.github.io/scikit-learn-intelex
IMPORTANT: there's still many issues left unresolved:
Version switchers do not update for older versions - i.e. if a user is browsing an old version, the switcher will be limited to the versions that were listed at creation of that doc page version (so e.g when creating 2025.2, the docs for 2025.0 won't list that version, remaining capped at 2025.1).FixedVersion switchers for older versions are still broken, as those have not been updated.FixedLinks in older versions might still point to the old intel URL instead of UXL (older doc pages have not been updated).Fixed for the version switcher onlyMain problem with #2214 is that its logic makes it so that each version of the docs handles the version switcher on that versioned doc page, instead of taking them from a common place.Updated current docs retroactively to make them all pull from the new version switcher.DISCLAIMER: I am not familiar with web development and am not 100% that what this PR is doing is correct.
Checklist to comply with before moving PR from draft:
PR completeness and readability
Testing
Not applicable.
Performance
Not applicable.