mne-tools / mne-tools/mne-python

Evaluate enabling `JupyterLite` support for selected sphinx-gallery examples

Open
#13,660 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

I noticed in the roadmap that improving documentation interactivity, particularly via JupyterLite support in sphinx-gallery, is an open goal.

As a starting point, i would like to explore enabling JupyterLite support for a small subset of lightweight examples (basic visualization or plotting examples) to evaluate feasibility and identify any constraints such as dependencies or build configuration.

If this direction makes sense, I can open a PR with an initial prototype and iterate based on feedback.

Please let me know if there are preferred examples or any prior work I should be aware of

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the roadmap reference and the existing sphinx-gallery examples and configuration. Identify a small set of lightweight visualization or plotting examples, then check JupyterLite dependency and build constraints. Done means producing an initial prototype or documenting feasibility and constraints for the proposed examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.