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

[pyOpenSci review] Better integrate notebook-based examples #545

Closed
rich-iannone opened this issue Dec 2, 2024 · 1 comment
Closed

[pyOpenSci review] Better integrate notebook-based examples #545

rich-iannone opened this issue Dec 2, 2024 · 1 comment

Comments

@rich-iannone
Copy link
Member

From the pyOpenSci comment:

Some of the examples are linking to the GitHub repository with pre-rendered notebooks. I don't like it so much and I usually prefer a solution like sphinx-gallery allowing a nicer integration with the documentation and provide examples that can be downloaded.

pyOpenSci/software-submission#202 (comment)

@machow
Copy link
Collaborator

machow commented Dec 12, 2024

I think this feedback makes a lot of sense -- pre-rendered notebooks in github aren't an ideal way to view examples. Our hope with making 1 of our 8 examples link to a notebook in github was to show examples in a variety of outputs. I think we wouldn't want to do much more linking to github notebooks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants