jupyterlite-sphinx icon indicating copy to clipboard operation
jupyterlite-sphinx copied to clipboard

Can you please provide a complete xeus-python example

Open paddymul opened this issue 1 year ago • 2 comments

Problem

I don't know how to configure jupyterlite-sphinx with xeus for my project. I have looked at ipycanvas, ipytone, ipyleaflet. All are configured slightly differently, and none of them completely work locally.

Suggested Improvement

I would like to see an example in a separate directory with a conf.py, environment.yml, makefile (since sphinx/readthedocs seems to be built with make by default, and any other necessary files to run a jupyterlite xeus-python kernel.

Having this self contained and separate is a much better starting point than trying to understand each individual piece of documentation.

If I get one of these projects to build xeus support properly I will publish it as a separate repo.

My usecase

I want to use sphinx-jupyterlite to show off my jupyter widget - buckaroo.

paddymul avatar Oct 21 '24 19:10 paddymul

Hi @paddymul, thanks for the suggestion! In the meantime, the documentation for this project itself uses the Xeus kernel, which can be tried on the homepage: https://jupyterlite-sphinx.readthedocs.io/en/latest/

An additional examples/ directory with the structure for a minimal website with both the Xeus and the Pyodide kernels sounds like a useful addition, and we can link to those directly under https://github.com/jupyterlite/jupyterlite-sphinx#example.

agriyakhetarpal avatar Nov 11 '24 18:11 agriyakhetarpal

For reference there is also some information about xeus-python in the docs: https://jupyterlite-sphinx.readthedocs.io/en/latest/configuration.html#pre-installed-packages

jtpio avatar Nov 12 '24 11:11 jtpio