Skip to content

Rework example gallery #58

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

Merged
merged 4 commits into from
Aug 6, 2024
Merged

Rework example gallery #58

merged 4 commits into from
Aug 6, 2024

Conversation

Teschl
Copy link
Contributor

@Teschl Teschl commented Aug 6, 2024

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

@wkearn
Copy link
Member

wkearn commented Aug 6, 2024

Looks great, @Teschl!

I edited your PR description so it wouldn't close all of the issues immediately.

@wkearn wkearn merged commit d4d0e34 into TopoToolbox:main Aug 6, 2024
6 checks passed
@wkearn wkearn mentioned this pull request Aug 6, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Sphinx docs grid_object.__init__ added twice Update README.md
2 participants