Skip to content
This repository was archived by the owner on Feb 14, 2024. It is now read-only.

Improve docs #28

Merged
merged 1 commit into from
Jun 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# jupyterlite-xeus-python-kernel
# jupyterlite-xeus-python

[![ci-badge]][ci] [![docs-badge]][docs]

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
master_doc = 'index'
source_suffix = '.rst'

project = 'xeus-python-kernel'
project = 'jupyterlite-xeus-python'
copyright = 'JupyterLite Team'
author = 'JupyterLite Team'

Expand Down
12 changes: 6 additions & 6 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ Requirements

This feature requires you to have at least ``conda``, `mamba <https://github.com/mamba-org/mamba>`_ or ``micromamba`` installed.

You also need to install ``emsdk``, this can be done by installing it from ``conda-forge``:
You also need to install ``empack``, this can be done by installing it from ``conda-forge``:

.. code::

conda install -c conda-forge emsdk
conda install -c conda-forge empack

# OR

mamba install -c conda-forge emsdk
mamba install -c conda-forge empack

# OR

micromamba install -c conda-forge emsdk
micromamba install -c conda-forge empack

Usage
~~~~~
Expand All @@ -35,13 +35,13 @@ You can pre-install packages by passing the ``XeusPythonEnv.packages`` CLI optio
.. note::
This will automatically install any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.

For example, say you want to install NumPy, Matplotlib and ipyleaflet, it can be done with the following command:
For example, say you want to install ``NumPy``, ``Matplotlib`` and ``ipyleaflet``, it can be done with the following command:

.. code::

jupyter lite build --XeusPythonEnv.packages=numpy,matplotlib,ipyleaflet

The same can be achieved through a `jupyterlite_config.json` file:
The same can be achieved through a ``jupyterlite_config.json`` file:

.. code::

Expand Down
13 changes: 10 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
xeus-python in JupyterLite
==========================
xeus-python in JupyterLite 🚀🪐
===============================

The `xeus-python <https://github.com/jupyter-xeus/xeus-python>`_ kernel compiled to wasm and installable in JupyterLite!!

Expand All @@ -9,8 +9,15 @@ Features:
- code completion
- code inspection
- interactive widgets (ipywidgets, ipyleaflet, bqplot, ipycanvas `etc`)
- JupyterLite custom file-system mounting

How does it compare with JupyterLite's ``Pyolite``?

- ``from time import sleep`` works!
- pre-installed packages: you can install the packages you want in your xeus-python lite installation (see :ref:`configuration` page)
- starts faster!
- it's lighter by default!
- pre-installed packages! No more piplite (see :ref:`configuration` page)
- no more piplite, but we will be working on a mambalite, stay stuned :D

.. replite::
:kernel: xeus-python
Expand Down