scikit-learn / scikit-learn

scikit-learn: machine learning in Python
https://scikit-learn.org
BSD 3-Clause "New" or "Revised" License
58.49k stars 25.04k forks source link

DOC final cleanup for switching to `pydata-sphinx-theme` #29037

Closed Charlie-XIAO closed 1 week ago

Charlie-XIAO commented 2 weeks ago

Note that this PR targets the new_web_theme branch!

Towards #28084.

The places marked with TODO(new_web_theme) are to be resolved in #29038 after this one is merged.

github-actions[bot] commented 2 weeks ago

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 1d19449. Link to the linter CI: here

Charlie-XIAO commented 1 week ago

@glemaitre @adrinjalali I think this is ready for review. I briefly went through the website and did not see fundamental problems. After the new web theme is deployed, I may:

Please feel free to navigate through the built artifact and let me know if there are problems that I overlooked.

glemaitre commented 1 week ago

I'm fine that we have a couple of glitches that will be removed soonish. Fixing upstream is more important because it will impact more people. That's nice.

glemaitre commented 1 week ago

FYI, we should not block the merge of this PR regarding this https://github.com/scikit-learn/scikit-learn/pull/29037#discussion_r1606646855

This can be tackled in a subsequent PR and I think that this is more valuable to have the website ready for 1.5

Charlie-XIAO commented 1 week ago

Sure (I'm sorry I wasn't at home so did not provide a timely update). Then shall we merge this one rn then I can quickly update #29038 to get the website ready?

glemaitre commented 1 week ago

Don't worry, I'll ping a second reviewer but I'm sure that we will be able to do it for 1.5 :) ping @jeremiedbb or @ogrisel

glemaitre commented 1 week ago

I just realized that I forgot "not" in my previous sentence.

StefanieSenger commented 1 week ago

There might be something wrong here: has this PR deleted doc/modules/classes.rst by accident or on purpose?

jeremiedbb commented 1 week ago

It was done on purpose. It's now listed in doc/api_reference.py

glemaitre commented 1 week ago

There might be something wrong here: has this PR deleted doc/modules/classes.rst by accident or on purpose?

Nop, now this file is generated with the doc/api_reference.py file. We will add an entry in the documentation to explain it.

StefanieSenger commented 1 week ago

Oh, I see then. Sorry, it seems I was looking for it to show up in some diff in the wrong place.