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: Fix version switcher code and update URLs and logos #2279

Merged

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)


PR extracting a subset from this one:
#2214

(without the GH action, just the source code)

It includes required changes to make new doc builds work correctly with the custom version switcher. These were already incorporated here:
#2274

In addition to the source code changes, it also updates the custom logos to use the ones from UXL foundation, taken from here:
https://github.com/uxlfoundation/uxlfoundation.org/tree/main/images

Note: this is hard-coding a versions.json file, but that file should ideally later on get built programmatically according to what's available.

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

  • I have run it locally and tested the changes extensively.
  • All CI jobs are green or I have provided justification why they aren't.

Performance

Not applicable.

Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure 77.96% <ø> (-0.01%) ⬇️
github 71.00% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 16 files with indirect coverage changes

Copy link
Contributor

@yuejiaointel yuejiaointel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi David,
I downloaded the doc generated in pipeline but I cannot click Choose version. It is greyed out, but it makes sense since the versions folders are not in main branch. Is this expected?
Best,
Screenshot 2025-01-27 101801

Yue

@david-cortes-intel
Copy link
Contributor Author

Hi David, I downloaded the doc generated in pipeline but I cannot click Choose version. It is greyed out, but it makes sense since the versions folders are not in main branch. Is this expected? Best, Screenshot 2025-01-27 101801

Yue

Yes, it's expected. If you look at the changes here, the script to build the docs needs to be passed a different argument to generate something with a version switcher, otherwise it won't have the .js file. Not sure if it needs the docs in named folders though.

Copy link
Contributor

@yuejiaointel yuejiaointel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code LGTM. But to see the final version switcher working with all the versions, I guess we need to merge this PR first and see it on gh-pages branch?

@david-cortes-intel
Copy link
Contributor Author

The code LGTM. But to see the final version switcher working with all the versions, I guess we need to merge this PR first and see it on gh-pages branch?

That was already done - the artifacts built from the source code in this PR (minus the entry for 2025.2 and the updated logos) were already deployed in a previous PR to 'gh-pages':
https://uxlfoundation.github.io/scikit-learn-intelex/

You'll see there that the version switcher is working there:
image

@david-cortes-intel david-cortes-intel merged commit 454096a into uxlfoundation:main Jan 29, 2025
27 checks 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.

4 participants