Skip to content
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

Update instructions for Jupyter notebook galleries #11545

Merged
merged 3 commits into from
Aug 20, 2024

Conversation

mgeier
Copy link
Contributor

@mgeier mgeier commented Aug 15, 2024

Since a while, nbsphinx doesn't depend on Sphinx-Gallery anymore and uses its own CSS (which can still be overwritten/extended by site authors), see spatialaudio/nbsphinx#706.


📚 Documentation previews 📚

@mgeier mgeier requested a review from a team as a code owner August 15, 2024 09:15
@mgeier mgeier requested a review from agjohnson August 15, 2024 09:15
@mgeier
Copy link
Contributor Author

mgeier commented Aug 15, 2024

BTW, Since you are mentioning "some examples of notebook galleries in the wild" and listing only a single one, I did a little search and found a few random galleries in the wild:

Feel free to add any of those to your list!

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this and updating it. We haven't updated with any list of examples in a while, so it might be good to add more current examples from your list too.

Comment on lines 240 to 241
This functionality is inspired by, but doesn't depend on
`Sphinx-Gallery <https://sphinx-gallery.github.io/>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose we can just drop this mention of sphinx-gallery too, it's seems more confusing than helpful if we aren't going to explain the difference between the two.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I've removed it in 2205a53.

@mgeier
Copy link
Contributor Author

mgeier commented Aug 16, 2024

I just realized that there was another mention of Sphinx-Gallery, which I removed in 9b3ce34.

And I saw that the screenshot is outdated. The new default CSS style looks different and the default dummy thumbnail as well.

@humitos
Copy link
Member

humitos commented Aug 20, 2024

I'm going to merge this PR, but feel free to open a another one with those more up-to-date gallery examples 💯

@humitos humitos merged commit 5fefc54 into readthedocs:main Aug 20, 2024
8 checks passed
@mgeier mgeier deleted the nbsphinx-gallery-update branch August 24, 2024 14:46
@mgeier
Copy link
Contributor Author

mgeier commented Aug 24, 2024

Thanks!

feel free to open a another one with those more up-to-date gallery examples

I'm not planning to do that. I was providing the example gallery links (#11545 (comment)) for someone else to take over!

Same for the outdated screenshot.

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.

3 participants