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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create gallery of realistic examples #2438

Open
Borda opened this issue Mar 7, 2024 · 0 comments
Open

Create gallery of realistic examples #2438

Borda opened this issue Mar 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@Borda
Copy link
Member

Borda commented Mar 7, 2024

馃殌 Feature

Motivation

We have some doctests to demonstrate immediate use, which is great but having demos with real-work examples would also be great for new users...

Pitch

have visual

Alternatives

We may not use our tutorials as they are optimized for long-running code, so we can try a simpler tool: https://sphinx-gallery.github.io/stable/index.html

Additional context

having these examples in Python script instead of notebooks directly...

so 馃煝 advantages:

  • regularly verified reproducibility
  • smaller footprint for the git versioning

and 馃煡 disadvantages:

  • not so cute view directly in GH
@Borda Borda added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Mar 7, 2024
@Borda Borda pinned this issue Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants
@Borda and others