jupyterlite/jupyterlite-sphinx

launching a jupyterlite open the lite folder

12rambau opened this issue · 5 comments

Description

I'm working on implementing a simple example of jupyterlite in the pydata-sphinx-theme (pydata/pydata-sphinx-theme#755). I try to keep it to the most simple example possible. I'm trying a retrolite display:

.. retrolite::
   :prompt: Try Retrolite!

but when I click on the prompt btn, it opens the lite folder instead of launching a notebook

Capture d’écran 2022-10-07 à 14 57 57

Reproduce

install the lib

pip install jupyterlite-sphinx

add the extension to my conf.py

# conf.py
extensions = [
    'jupyterlite_sphinx',
]

nothing else (maybe that's actually the issue)

Context

  • JupyterLite version: latest
  • Operating System and version: MacOSX 12.5.1
  • Browser and version: Safari 16.0

Thanks for opening an issue :)

It's expected that

.. retrolite::
   :prompt: Try Retrolite!

opens the tree.

You can open a Notebook by passing it:

.. retrolite:: my_notebook.ipynb
   :prompt: Try Retrolite!

Also, if what you want is the most simple JupyterLite setup, I can suggest using replite to just get a repl:

.. replite::
   :prompt: Try Retrolite!

Thanks a lot for your fast answer. I'll have a look at the replite command.
The path to the file is relative the source folder ? or the jupyterlite_contents configuration parameter ?

Since this PR (introduced in 0.7.2), .. retrolite:: my_notebook.ipynb should consider my_notebook.ipynb as being relative to the .rst file.

Please report back if what I just said is correct 😁, I'm not 100% sure

I tried using a custom notebook:

.. retrolite:: ./_templates/my_notebook.ipynb
   :prompt: Try Retrolite!

no error is raised but the tree is still opening instead of the jupyterlite instance

I still fail to make it work on my local computer but I managed to have a working display in pydata/pydata-sphinx-theme#1023. feel free to close the issue if you think it's coming from my computer set up