DOC using pydata doc theme - #1774

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.21%. Comparing base (5d1653a) to head (a8e9d5e).
⚠️ Report is 27 commits behind head on main.

@@            Coverage Diff             @@
##             main    #1774      +/-   ##
==========================================
- Coverage   94.29%   94.21%   -0.08%     
==========================================
  Files          46       46              
  Lines        7922     7922              
==========================================
- Hits         7470     7464       -6     
- Misses        452      458       +6     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

I had a very cursory look, but it looks cool!! Thanks

Maybe it's just me and old habits die hard, but looking at the rendered doc, the fact that the left-hand side navigation has disappeared feels like something is kind of missing.

Here is the left-hand side navigation I am talking about in the current doc.

It took me a while to find the header 😅, also you need one more click to see the different sections, first click on "User manual" then get a not so nice looking TOC, then you can chose the section you want to look at. Previously you could see the different sections directly ...

Maybe it's just me though, and also I have no idea whether this comes with pydata-sphinx-theme and there is not much we can do to tweak it.

On the plus side, probably people are more used to pydata-sphinx-theme that many projects use and having a search bar is definitely nice.

I changed a bit the looking of the TOC you referenced @lesteve . The navigation is still there but not visible from the main page. There is a navigation sidebar for each section User Manual, Module reference, Development, instead of having a global navigation sidebar.

It indeed comes from pydata-sphinx-theme, and I don't think we could tweak it. Main sections are in the header and subsections are in the sidebar. IMO it's fine, it makes the sidebar clearer, showing less information.

Thanks!

Maybe "Examples" are important and should be added to the top-level header as well?

skrub has it and scikit-learn too

Yes, I agree, will do it :)

I clicked around a bit and it looks good.

Two more things from me:

• maybe use "User Guide" rather than "User Manual" since this is the term that we tend to use in scikit-learn and related projects?
• similarly name the folder user_guide rather than user?

Regarding the doc, I would say:

• Remove persistence from the front page. This is not what we want to advocate for (pickle is not great for long term persistence).
• Add parallel backend (and reorder the user guide accordingly).
• Add 3 extra boxes on the second row? API, examples, release notes?
• The gray of the logo is better but can be slightly darker?

I was a bit surprised by the front page, mayeb the logo is a bit big and the purpose of the lib not so clear? Not sure how to improve though.

I tried two layouts for the first page. I would say, I prefer the logo above, but maybe you prefer inside a sidebar.

I like both, no real preference

also add an entry in the changelog.

The changelog has been added in the last commit

thanks a lot @Nanored4498 ! This looks pretty and it is a nice re-organization :)