ENH: Add optional JupyterLite support prototype for documentation interactivity#13666
ENH: Add optional JupyterLite support prototype for documentation interactivity#13666aman-coder03 wants to merge 9 commits intomne-tools:mainfrom
Conversation
|
@drammock can you please have a look at this? |
|
Sorry for the slow reply. I think this PR should modify 1 page in the docs to actually embed a jupyterlite interactive terminal so we can test it out on the CI-rendered docs page. Once we know it's working, we can discuss how to proceed (1 page at a time vs lots of pages at once; whether every tutorial gets it or only certain ones; whether the env var is the right way to turn it on/off; etc) |
|
i think |
looks like the problem is |
|
Yes, exactly. |
Reference issue (if any)
Refs #13660.
What does this implement/fix?
This PR adds optional support for the
jupyterlite_sphinxextension in thedocumentation configuration (
doc/conf.py) as an initial step toward enablinginteractive examples using JupyterLite.
The extension is only enabled when the environment variable
MNE_ENABLE_JUPYTERLITE=trueis set and the dependency is installed. This keepsthe default documentation build and CI unchanged while allowing JupyterLite to
be tested locally or in future integrations.
The goal is to establish a safe starting point for experimenting with interactive
sphinx-gallery examples, in line with the documentation interactivity roadmap.
Additional information
This change does not alter any existing examples or documentation behavior by
default. It simply adds a configuration hook so that JupyterLite support can be
incrementally explored and expanded in follow-up PRs.
Happy to adjust the approach if there is a preferred way to integrate this.