8000 DOC: move example by GaelVaroquaux · Pull Request #20624 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC: move example #20624

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

Conversation

GaelVaroquaux
Copy link
Member

Move plot_permutation_test_for_classification from feature_selection to model_selection, where it feels more natural, as discussed in #20622 with @thomasjpfan

Move plot_permutation_test_for_classification from feature_selection to
model_selection, where it feels more natural
@ogrisel
Copy link
Member
ogrisel commented Jul 28, 2021

Maybe we should add a stub example with a sphinx reference to the new location to avoid breaking incoming URLs?

@GaelVaroquaux
Copy link
Member Author
GaelVaroquaux commented Jul 28, 2021 via email

@GaelVaroquaux
Copy link
Member Author

OK, this is good to go, now including a redirection.

@glemaitre
Copy link
Member

Just an additional thought: is there a way in sphinx-gallery to not show the thumbnail in the gallery.
The rendering in the "Feature Selection" section of the thumbnail seems to be problematic: https://146025-843222-gh.circle-artifacts.com/0/doc/auto_examples/index.html#model-selection

@GaelVaroquaux
Copy link
Member Author

is there a way in sphinx-gallery to not show the thumbnail in the gallery?

Cc @lucyleeow

@GaelVaroquaux
Copy link
Member Author

I pushed something that should improve a bit the thumbnail in the gallery

@GaelVaroquaux
Copy link
Member Author

Things are now slightly better in the thumbnail gallery.

@lucyleeow
Copy link
Member
lucyleeow commented Jul 28, 2021

is there a way in sphinx-gallery to not show the thumbnail in the gallery?

Cc @lucyleeow

Do you mean showing the default thumbnail image instead of a figure from the example? I think this would work: https://sphinx-gallery.github.io/stable/configuration.html#providing-an-image-for-the-thumbnail-image

@GaelVaroquaux
Copy link
Member Author
GaelVaroquaux commented Jul 28, 2021 via email

@lucyleeow
Copy link
Member

How is auto_examples/index.rst generated?

@GaelVaroquaux
Copy link
Member Author
GaelVaroquaux commented Jul 28, 2021 via email

@glemaitre
Copy link
Member

We don't tweak so many things apart of the sections ordering: https://github.com/scikit-learn/scikit-learn/blob/main/doc/conf.py#L334

@glemaitre
Copy link
Member

If there is not easy way, I am OK with the current solution of @GaelVaroquaux

@lucyleeow
Copy link
Member

How is auto_examples/index.rst generated?
By sphinx-gallery, I believe.

😅 Yes it is. I can't see a way to prevent it being added to the index but still be converted to rst, not even an ugly hack. Would need a new config item to be added.

@glemaitre glemaitre merged commit 2c2c6ca into scikit-learn:main Jul 28, 2021
@glemaitre
Copy link
Member

OK so let's go with the current proposal. Thanks @GaelVaroquaux @lucyleeow

@thomasjpfan
Copy link
Member

Opened #20625 to improve redirections.

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
0