feature: trigger doc build on release tag #2301
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Flags with carried forward coverage won't be shown. Click here to find out more. |
yuejiaointel
changed the title
yuejiaointel
requested review from
napetrov,
Alexsandruss,
samir-nasibli,
homksei,
ahuber21 and
ethanglaser
as code owners
|
@yuejiaointel Looks like there's something wrong with the "latest" folder in the PR that the bot made in your fork. It should be an identical copy of the new version that got added, but it doesn't contain .html files. Also, could you enable the "pages" functionality in your fork so that we can see the rendered docs? You can do so in the repository settings: |
Looking into it rn. Enabled the pages the rendered links should be visible at https://yuejiaointel.github.io/scikit-learn-intelex |
|
|
||
| html_context = { | ||
| "current_version": version, | ||
| "project_name": "scikit-learn-intelex", | ||
| "switcher_url": switcher_url, |
There was a problem hiding this comment.
@yuejiaointel This line needs to be here for the version switcher to work. Perhaps it could be left with only version "latest" on the main branch, while being re-generated for the "gh-pages" branch.
There was a problem hiding this comment.
@yuejiaointel It does need to point to a JSON file - sorry about the earlier comment about removing it entirely.
There was a problem hiding this comment.
Thx, that make sense now, I was wondering why version switcher does not work.
Link throws a 404 by default, unless specifying a previous version like "2025.1": |
.github/workflows/docs-release.yml
Outdated
| if git fetch origin gh-pages; then | ||
| git checkout gh-pages | ||
| else | ||
| git checkout -b gh-pages |
There was a problem hiding this comment.
I think better to error out with an informative message in this situation. Otherwise it anyway wouldn't let you merge the commits.
There was a problem hiding this comment.
Good catch! Fixed now it will error out
There was a problem hiding this comment.
These styles are are applied automatic when I save, would it be okay if we keep them?
There was a problem hiding this comment.
So is this file, before some automatic headers are added but they are not correct comment in js and is causing layout.html to not recognize the load_versions function
Fixed! The version_switcher.js is having some wrong style comment on top and is causing layout html to not recognize the load_versions function. Now link and version switcher should work |
Description
Hi all,
This PR intends to automate the process to release sklearnex doc. Main changes are in a new file called doc-release.yml. Automation will be triggered if a valid tag is pushed.
Best
PR completeness and readability
Testing