Rework example gallery #58
Merged
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.
This reworks the example gallery in the documentation. It's possible to add custom thumbnails to each tile now. I have reduced the notebooks down to four files. Once we decide how we want to design the thumbnails, we can close 36. I also added a reference to the tests in our README and resolved #46 (
__init__
twice in docs).I spend way too long trying to find this solution. Since nbsphinx is not the only extension that can generate galleries, I tried to implement a few of them before I finally figured out this, admittedly, very easy solution that is implemented now.
Seaborn for example uses Sphinx Gallery, and they were able to easily add custom thumbnails. I first tried to convert our docs to support Sphinx Gallery. This requires
.py
files that will in turn be converted to.ipynb
files when building. That would mean either having the examples stored twice or not having any notebooks to work with. So I scrapped this approach again.closes #18
I think we can also close 27 since that is all implemented now. Therefor that also resolves 30