Automatic example galleries in API pages #2136
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
regislebrun
approved these changes
Sep 16, 2022
jschueller
approved these changes
Sep 19, 2022
sofianehaddad
approved these changes
Sep 19, 2022
|
The rendering is great. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the discussion at yesterday's meeting, I have implemented @mdelozzo's suggestion of adding minigalleries of exampls in API doc pages.
It seems to me there is no need to exclude often used classes like Point and Sample, because the minigallery is at the end of the page and thus unobstrusive. The minigallery is however mentioned in the table of contents at the top right-hand corner, so it can be quickly accessed if needed.
As an example, here is the top of the KrigingAlgorithm page:
And here the bottom of the KrigingAlgorithm page:
Closes #2115