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

Restructure the docs

Open aepanchi opened this issue 1 year ago • 3 comments

Description

Restructure the docs and rewrite the onboarding docs. The approximate output is available at https://aepanchi.github.io/scikit-learn-intelex/index.html

Changes proposed in this pull request:

  • Change the doc structure.
  • Create README.md for the doc folder with instruction on how to build docs locally.
  • Update conf.py with extensions required for a doc build.
  • Update contribute.rst and support.rst
  • Update index.rst: delete the unnecessary information, update acceleration image, add examples.
  • Fix layout in several files to align with the rest.
  • Create tutorials.rst
  • Update quick-start: move there installation, system and memory requirements, releases, and patching.
  • Delete mentions of macOS since this doc set is for 2024.x

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

aepanchi avatar Jan 31 '24 16:01 aepanchi

partially reviewed

one small observation is that we have docs/ in oneDAL and doc/ in sklearnex - would we want to align these?

Thanks for the review! We can align them, but it is not required.

aepanchi avatar Feb 08 '24 14:02 aepanchi

Nice work, docs are easy to navigate and looks improved from previous docs. Mostly minor comments, once docbuild passes then looks good to me.

Thanks! Updated the requirements file, and the CI has passed :)

aepanchi avatar Feb 09 '24 09:02 aepanchi

Messed up formatting in quick start

image

napetrov avatar Feb 13 '24 08:02 napetrov

Messed up formatting in quick start

image

It will be fine in the repos build since we have max-width: 1200px;

aepanchi avatar Feb 26 '24 15:02 aepanchi

@aepanchi any more to be done on this one?

ethanglaser avatar Mar 25 '24 16:03 ethanglaser

@ethanglaser Hi, I addressed all of the comments. Are you okay with merging?

aepanchi avatar Mar 27 '24 13:03 aepanchi