grouping examples into sections#2102
Conversation
jeromedockes
added
documentation
rcap107
left a comment
rcap107
left a comment
There was a problem hiding this comment.
Thanks for the PR @maureen-githaiga, this will be useful.
There are a few things that need to be fixed
At the moment, the examples that have been moved to the new folders are not being rendered because the folders are missing a file that's called GALLERY_HEADER.rst and that contains the title of the section. You can check out those that are already in the folder as examples of what they look like.
Some of the examples should be moved in locations different from where they currently are.
Also, the name of the folders themselves should be prefixed by a number (like "01_encoding", 02_data_ops", "03_joiners". Doing so allows us to set the order of the folders.
There was a problem hiding this comment.
This file should be moved back to the fixme folder (we might be removing this entirely)
There was a problem hiding this comment.
For both this and the other joiners, there is no need to nest it twice: having the "joiners" section on its own is enough, so this should be moved up by one folder.
There was a problem hiding this comment.
this can go in the root examples/ folder
There was a problem hiding this comment.
this may also go in the root examples folder
|
|
||
| Changes | ||
| ------- | ||
| - Grouped Examples into three sections. :pr:`690` by |
There was a problem hiding this comment.
the PR number is 2102 (690 is the relevant issue)
| - Grouped Examples into three sections. :pr:`690` by | |
| - Grouped Examples into three sections. :pr:`2102` by |
3 participants
fixes #690
Grouped examples into different sections/folders.