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

Automatic CI Doc Build #1785

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

Automatic CI Doc Build #1785

wants to merge 24 commits into from

Conversation

aepanchi
Copy link
Contributor

@aepanchi aepanchi commented Apr 3, 2024

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 alexandra.epanchinzeva@intel.com

doc/set_version.sh Outdated Show resolved Hide resolved
doc/set_version.sh Outdated Show resolved Hide resolved
doc/index.html Outdated Show resolved Hide resolved
doc/index.html Outdated Show resolved Hide resolved
doc/versions.json Outdated Show resolved Hide resolved
@ethanglaser
Copy link
Contributor

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

aepanchi and others added 7 commits April 4, 2024 17:11
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
Co-authored-by: Nikolay Petrov <nikolay.a.petrov@intel.com>
doc/sources/conf.py Outdated Show resolved Hide resolved
aepanchi and others added 2 commits April 4, 2024 17:48
Co-authored-by: ethanglaser <42726565+ethanglaser@users.noreply.github.com>
doc/set_version.sh Outdated Show resolved Hide resolved
Co-authored-by: ethanglaser <42726565+ethanglaser@users.noreply.github.com>
doc/set_version.sh Outdated Show resolved Hide resolved
doc/set_version.sh Outdated Show resolved Hide resolved
doc/sources/conf.py Outdated Show resolved Hide resolved
@ethanglaser
Copy link
Contributor

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

doc/build-doc.sh Show resolved Hide resolved
doc/set_version.sh Outdated Show resolved Hide resolved
o.value = entry.url;
if (current_version == entry.version){
o.selected = true;
optionText = optionText;
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't understand this assignment

doc/sources/conf.py Show resolved Hide resolved
@aepanchi
Copy link
Contributor Author

@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.

doc/sources/conf.py Outdated Show resolved Hide resolved
@ethanglaser
Copy link
Contributor

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

@samir-nasibli
Copy link
Contributor

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

@emmwalsh
Copy link
Contributor

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

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

@samir-nasibli
Copy link
Contributor

@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?

@emmwalsh
Copy link
Contributor

emmwalsh commented Jun 14, 2024

@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
Copy link
Contributor

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

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