Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can you please provide a complete xeus-python example #212

Open
paddymul opened this issue Oct 21, 2024 · 2 comments
Open

Can you please provide a complete xeus-python example #212

paddymul opened this issue Oct 21, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@paddymul
Copy link

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 paddymul added the documentation Improvements or additions to documentation label Oct 21, 2024
@agriyakhetarpal
Copy link
Collaborator

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.

@jtpio
Copy link
Member

jtpio commented Nov 12, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants