scikit-learn-intelex icon indicating copy to clipboard operation
scikit-learn-intelex copied to clipboard

Automatic CI Doc Build

Open aepanchi opened this issue 10 months ago • 9 comments

Description

Enable automatic CI doc build once the main is updated. Propose a better version control solution. Output is available at https://aepanchi.github.io/scikit-learn-intelex/2024.3/

Changes proposed in this pull request:

  • Introduce:
    • .github/workflows/publish.yml to enable automatic CI doc build
    • doc/index.html to redirect user to the latest doc version
    • doc/set_version.sh to set the doc version
    • doc/sources/_static/version_switcher.js and doc/sources/_templates/versions.html to switch versions
    • doc/versions.json to specify the doc versions to build
  • Rename doc/sources/_static/style.css to doc/sources/_static/custom.css to align with conf.py; update the file with the version dropdown button configurations
  • Update conf.py to include new configurations

Signed-off-by: Alexandra Epanchinzeva [email protected]

aepanchi avatar Apr 03 '24 10:04 aepanchi

Doc build CI fail: FileNotFoundError: [Errno 2] No such file or directory: 'doc_version.json'

ethanglaser avatar Apr 04 '24 14:04 ethanglaser

The relative file paths seem to be adding some instability - is there an advantage to creating a json file over setting an environment variable or something like that? ie remove doc_version.json creation and instead get the environment variable here https://github.com/aepanchi/scikit-learn-intelex/blob/docs-ci/doc/sources/conf.py#L40

ethanglaser avatar Apr 15 '24 21:04 ethanglaser

@ethanglaser @napetrov CI passes all checks except the doc one. The error is:

FileNotFoundError: [Errno 2] No such file or directory: 'sources/doc_version.json'
make: *** [Makefile:36: html] Error 2

But the script creates the file on the next line.

aepanchi avatar Apr 23 '24 10:04 aepanchi

publish.yml is not being triggered from anywhere - the failing step is from .ci/pipeline/docs.yml which does not include any of the necessary logic

ethanglaser avatar Apr 29 '24 02:04 ethanglaser

@aepanchi who will continue to work on this PR? @ethanglaser @emmwalsh

samir-nasibli avatar Jun 14 '24 09:06 samir-nasibli

@aepanchi who will continue to work on this PR? @ethanglaser @emmwalsh

Hi @samir-nasibli I don't support scikit learn. Only oneDAL and daal4py

emmwalsh avatar Jun 14 '24 09:06 emmwalsh

@aepanchi who will continue to work on this PR? @ethanglaser @emmwalsh

Hi @samir-nasibli I don't support scikit learn. Only oneDAL and daal4py

Thank you! I would like to clarify, is that mean that you are only support scikit-learn-intelex/daal4py documentation?

samir-nasibli avatar Jun 14 '24 09:06 samir-nasibli

@aepanchi who will continue to work on this PR? @ethanglaser @emmwalsh

Hi @samir-nasibli I don't support scikit learn. Only oneDAL and daal4py

Thank you! I would like to clarify, is that mean that you are only support scikit-learn-intelex/daal4py documentation?

so I will be approving PRs and customer-reported bugs at the moment

emmwalsh avatar Jun 14 '24 10:06 emmwalsh

Hi @samir-nasibli, I double-checked my support, and it says that I cover sci-kit-learn for PR reviews, so I think Ethan might be the best person to take over this PR. Then I can review it

emmwalsh avatar Jun 14 '24 10:06 emmwalsh