Add scikit-learn to the example gallery #1985
Conversation
Coverage report
This PR does not seem to contain any modification to coverable code. |
|
What you did with the API and the gallery is mind-blowing to me. I would have never expected it to be so smooth to crawl through your super heavy API. I think considering your commitment into customization you clearly won you place among the featured websites. I'll wait for other maintainers point of view. |
There was a problem hiding this comment.
beautiful! would be great to see some of those customizations upstreamed (I think you tried already to upstream some of them e.g. #1951, and our ability to do timely review might have been the rate-limiter --- but rest assured that for me at least it's lack of time, not lack of interest!).
I'd be particularly interested in seeing the filterable API table become something other libs could re-use (not sure if it makes more sense as a Sphinx extension or as part of this theme). After a quick glance at the source, the way you use Jinja to build it might be a bit tricky to generalize, not sure, but would love to see someone try :)
|
oh, and +1 for adding to the "featured" list. @Charlie-XIAO do you need any guidance on how to do that in this PR? |
|
Thanks @12rambau @drammock! I'm moving scikit-learn to the featured examples gallery then (1381913) Please let me know if I'm doing wrong :)
Thanks! I will try to ship whatever reasonable for the upstream - that also reduces maintenance burden on the scikit-learn side especially when upgrading pst versions. |
|
Definitely agree we should add it to featured 👍. Scikit learn is a pillar in the scipy community and I think we should definitely highlight it. I also love the idea of more upstreaming 🙂 Thanks @Charlie-XIAO |
There was a problem hiding this comment.
looks like it worked: https://pydata-sphinx-theme--1985.org.readthedocs.build/en/1985/examples/gallery.html
:)
|
Sorry I've just noticed that the generated screenshot looks a bit weird. I've opened #1990 to try to fix it. |
Follow up #1985, there seems to something wrong with the generated screenshot, probably because the root has a canonical link that points to stable. Sorry for the mistake. | Before | After | | :----: | :---: | |  |  |
Thanks for the amazing theme! Scikit-learn has migrated to pydata-sphinx-theme for the main website since version 1.5 (scikit-learn/scikit-learn#29038), and the nice three-column layout has unlocked many potential improvements to our website UI/UX-wise. This PRs adds scikit-learn to the list of `Other projects using this theme`. However though scikit-learn is not one of the earliest adopters of pydata-sphinx-theme, I'm asking if it can fit into the list of `Featured projects` as we have many quite some customizations that could be helpful for other users of the theme. Some of them include: - [Landing page](https://scikit-learn.org/) - [API references](https://scikit-learn.org/stable/api/index.html) (a searchable table on the index page containing all APIs while keeping the hierarchy in the primary sidebar) - [Each API page](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) (customizing the secondary sidebar) - [Gallery examples](https://scikit-learn.org/stable/auto_examples/release_highlights/plot_release_highlights_1_5_0.html) (secondary sidebar customization with sphinx-gallery) - [Platform-specific installation instructions](https://scikit-learn.org/stable/install.html#installing-the-latest-release) (CSS customizations based on tabs in sphinx-design) - [Dropdowns](https://scikit-learn.org/stable/modules/linear_model.html#references) (anchor link for dropdown blocks; toggle-all button for Ctrl-F searching) - Algolia search (WIP): scikit-learn/scikit-learn#29666 - Many other CSS customizations Looking forward to your feedback :) *BTW some of the projects were not placed in alphabetical order as required so I reordered a bit.*
Follow up pydata#1985, there seems to something wrong with the generated screenshot, probably because the root has a canonical link that points to stable. Sorry for the mistake. | Before | After | | :----: | :---: | |  |  |
Thanks for the amazing theme! Scikit-learn has migrated to pydata-sphinx-theme for the main website since version 1.5 (scikit-learn/scikit-learn#29038), and the nice three-column layout has unlocked many potential improvements to our website UI/UX-wise. This PRs adds scikit-learn to the list of
Other projects using this theme.However though scikit-learn is not one of the earliest adopters of pydata-sphinx-theme, I'm asking if it can fit into the list of
Featured projectsas we have many quite some customizations that could be helpful for other users of the theme. Some of them include:Looking forward to your feedback :)
BTW some of the projects were not placed in alphabetical order as required so I reordered a bit.