Skip to content

Create gallery of realistic examples #2438

Open
@Borda

Description

@Borda

🚀 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is neededwontfix

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions