Skip to content
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

Merged
merged 16 commits into from
Jan 27, 2025

Conversation

david-cortes-intel
Copy link
Contributor

@david-cortes-intel david-cortes-intel commented Jan 27, 2025

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). Fixed
  • Version switchers for older versions are still broken, as those have not been updated. Fixed
  • Links 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 only
  • The version switcher can point to a non-existent sub-page - for example, if one is browsing a section like "Non-Scikit-Learn Algorithms" which was added in e.g. 2025.0, the version switcher will still offer to switch to that page in 2024.6, but that page doesn't exist in 2024.6 which leads to a 404 error.

Main 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

  • I have reviewed my changes thoroughly before submitting this pull request.
  • 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

Not applicable.

Performance

Not applicable.

@david-cortes-intel david-cortes-intel changed the title [WIP, Do not merge] Add docs for 2025 releases DOC: Add docs for 2025 releases Jan 27, 2025
@david-cortes-intel david-cortes-intel marked this pull request as ready for review January 27, 2025 10:13
@yuejiaointel
Copy link
Contributor

Hi David,
Just wondering do we have to add all these binary build files/images/rst files to git, why not just build them on fly?
Best,
Yue

@ethanglaser
Copy link
Contributor

Hi David, Just wondering do we have to add all these binary build files/images/rst files to git, why not just build them on fly? Best, Yue

I am also wondering this. This seems like a lot of overhead to be added to the codebase.

@david-cortes-intel
Copy link
Contributor Author

This seems like a lot of overhead to be added to the codebase.

These are going to the branch gh-pages which is from where the docs get deployed, not to the main branch. This branch gh-pages doesn't contain any source code besides the custom JS.

why not just build them on fly?

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.

@Alexsandruss Alexsandruss merged commit ce5d730 into uxlfoundation:gh-pages Jan 27, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants