Fix incorrect paths for JupyterLite Notebook interface URLs, unpin jupyterlite-sphinx, and update JupyterLite integration docs#1417
Conversation
|
For example, the Lab URL for Thank you! |
There was a problem hiding this comment.
LGTM thanks!
Just for info, I assume this change was bought about when https://github.com/jupyterlab/retrolab was archived and integrated into Jupyter Notebook?
(CI failures unrelated)
|
Thanks for the review! Yes, this was indeed the case – the last instance of So your assessment is right, it was dropped with jupyterlite/jupyterlite#1019 |
|
CI failures should be fixed by #1416 We should probably add/update jupyterlite min pin to 0.4.2 then, since it seems like that was the release with the linked PR. Or maybe we at least need some doc update? Also our CIs ( |
|
Ah, thank you for fixing the CI failures before I was able to! :) I agree with both adding a minimum version for JupyterLite and updating the docs about it – just pushed the relevant changes via 821d17d and 616e547. Suggestions on improving the documentation are appreciated. I think it could make sense to move the sentence to an admonition too. Minor points about |
|
Also, |
lucyleeow
left a comment
There was a problem hiding this comment.
Thank you for the doc updates. Just some nits, you have to double backtick here (single is just italics) because we don't set a default.
jupyterlite-sphinx, and update JupyterLite integration docs
Description
I noticed that while JupyterLite dropped the "retro" string in the URL for the Notebook interface at some point in time,
sphinx-gallerystill seems to have it – and I recently hit this on scikit-image/scikit-image#7644 where I wanted to use it for the gallery notebooks. This PR fixes it, so that the buttons inserted bysphinx-gallerynow open the correct link:http://127.0.0.1:8000/lite/notebooks/index.html?path=my_notebook.ipynb,instead of the broken one below
http://127.0.0.1:8000/lite/retro/notebooks/index.html?path=my_notebook.ipynbIt appears that this was not caught in other projects, such as
scikit-learn, because the "Lab" interface is used there, for which the URL is correct here.I also tried to add a minimal test to ensure that this breakage does not happen again, by creating a minimal web server as a pytest fixture, but realised that it would require a JupyterLite site to be built during the test suite – which is quite overkill.
Additional context
N/A