Update to jupyterlite v0.2 (#113)

* Update to jupyterlite v0.2

* Install xeus-python with pip

* Formatting issue

* Variable shadowing

* Install from conda-forge

* Try fixing path

Author: martinRenou

dev-environment.yml

@@ -5,8 +5,8 @@ dependencies:
     - pip
     - jupyter_server
     - jupyterlab_server
-    - jupyterlite-core >=0.1.0,<0.2
-    - jupyterlite-xeus-python >=0.9.0,<0.10.0
+    - jupyterlite-xeus-python >=0.9.7,<0.10.0
+    - jupyterlite-core >=0.2,<0.3
     - pydata-sphinx-theme
     - myst-parser
     - docutils

docs/directives/notebooklite.md

@@ -0,0 +1,33 @@
+# NotebookLite directive
+
+`jupyterlite-sphinx` provides a `notebooklite` directive that allows you to embed the classic Notebook UI in your docs.
+
+```rst
+.. notebooklite::
+   :width: 100%
+   :height: 600px
+   :prompt: Try classic Notebook!
+```
+
+```{eval-rst}
+.. notebooklite::
+   :width: 100%
+   :height: 600px
+   :prompt: Try classic Notebook!
+```
+
+You can also pass a Notebook file to open:
+
+```rst
+.. notebooklite:: my_notebook.ipynb
+   :width: 100%
+   :height: 600px
+   :prompt: Try classic Notebook!
+```
+
+```{eval-rst}
+.. notebooklite:: my_notebook.ipynb
+   :width: 100%
+   :height: 600px
+   :prompt: Try classic Notebook!
+```

docs/directives/retrolite.md

@@ -3,6 +3,6 @@
 You can access the JupyterLite deployment that `jupyterlite-sphinx` made for you, in fullscreen, following the `./lite/lab` and `./lite/retro` relative urls:
 
 - [JupyterLab](./lite/lab/index.html)
-- [Retrolab](./lite/retro/index.html)
+- [Notebook](./lite/tree/index.html)
 
-If you want to open a specific notebook in fullscreen  JupyterLab/Retrolab you can use the `path` URL parameter, e.g. `./lite/lab/?path=my_noteboook.ipynb`.
+If you want to open a specific notebook in fullscreen  JupyterLab/Notebook you can use the `path` URL parameter, e.g. `./lite/lab/?path=my_noteboook.ipynb`.

docs/full.md

@@ -37,7 +37,7 @@ Each of those directives can be configured with the following options:
 :maxdepth: 2
 
 directives/jupyterlite
-directives/retrolite
+directives/notebooklite
 directives/replite
 directives/voici
 full

docs/index.md

@@ -162,14 +162,14 @@ class JupyterLiteIframe(_LiteIframe):
     notebooks_path = ""
 
 
-class RetroLiteIframe(_LiteIframe):
-    """Appended to the doctree by the RetroliteDirective directive
+class NotebookLiteIframe(_LiteIframe):
+    """Appended to the doctree by the NotebookliteDirective directive
 
-    Renders an iframe that shows a Notebook with RetroLite.
+    Renders an iframe that shows a Notebook with NotebookLite.
     """
 
-    lite_app = "retro/"
-    notebooks_path = "notebooks/"
+    lite_app = "tree/"
+    notebooks_path = "../notebooks/"
 
 
 class VoiciIframe(_PromptedIframe):
@@ -287,7 +287,7 @@ def run(self):
 
             notebooks_dir = Path(self.env.app.srcdir) / CONTENT_DIR / notebook_name
 
-            # Copy the Notebook for RetroLite to find
+            # Copy the Notebook for NotebookLite to find
             os.makedirs(os.path.dirname(notebooks_dir), exist_ok=True)
             try:
                 shutil.copyfile(notebook, str(notebooks_dir))
@@ -319,13 +319,13 @@ class JupyterLiteDirective(_LiteDirective):
     iframe_cls = JupyterLiteIframe
 
 
-class RetroLiteDirective(_LiteDirective):
-    """The ``.. retrolite::`` directive.
+class NotebookLiteDirective(_LiteDirective):
+    """The ``.. notebooklite::`` directive.
 
-    Renders a Notebook with RetroLite in the docs.
+    Renders a Notebook with NotebookLite in the docs.
     """
 
-    iframe_cls = RetroLiteIframe
+    iframe_cls = NotebookLiteIframe
 
 
 class VoiciDirective(_LiteDirective):
@@ -345,10 +345,10 @@ def run(self):
         return super().run()
 
 
-class RetroLiteParser(RSTParser):
+class NotebookLiteParser(RSTParser):
     """Sphinx source parser for Jupyter notebooks.
 
-    Shows the Notebook using retrolite."""
+    Shows the Notebook using notebooklite."""
 
     supported = ("jupyterlite_notebook",)
 
@@ -357,7 +357,7 @@ def parse(self, inputstring, document):
         # Make the "absolute" filename relative to the source root
         filename = "/" + os.path.relpath(document.current_source, self.env.app.srcdir)
         super().parse(
-            f"{title}\n{'=' * len(title)}\n.. retrolite:: {filename}",
+            f"{title}\n{'=' * len(title)}\n.. notebooklite:: {filename}",
             document,
         )
 
@@ -388,7 +388,7 @@ def run(self):
         relative_path_to_root = "/".join([".."] * depth)
         prefix = os.path.join(relative_path_to_root, JUPYTERLITE_DIR)
 
-        lite_app = "retro/"
+        lite_app = "tree/"
         notebooks_path = "notebooks/"
 
         content_container_node = nodes.container(
@@ -410,7 +410,7 @@ def run(self):
             self.env.temp_data["generated_notebooks"][
                 directive_key
             ] = notebook_unique_name
-            # Copy the Notebook for RetroLite to find
+            # Copy the Notebook for NotebookLite to find
             os.makedirs(notebooks_dir, exist_ok=True)
             with open(notebooks_dir / Path(notebook_unique_name), "w") as f:
                 # nbf.write incorrectly formats multiline arrays in output.
@@ -547,7 +547,11 @@ def jupyterlite_build(app: Sphinx, error):
         for content in jupyterlite_contents:
             contents.extend(["--contents", content])
 
-        voici_option = [] if voici is None else ["--apps", "voici"]
+        apps_option = []
+        for liteapp in ["notebooks", "edit", "lab", "repl", "tree", "consoles"]:
+            apps_option.extend(["--apps", liteapp])
+        if voici is not None:
+            apps_option.extend(["--apps", "voici"])
 
         command = [
             "jupyter",
@@ -560,13 +564,7 @@ def jupyterlite_build(app: Sphinx, error):
             os.path.join(app.srcdir, CONTENT_DIR),
             "--output-dir",
             os.path.join(app.outdir, JUPYTERLITE_DIR),
-            "--apps",
-            "lab",
-            "--apps",
-            "retro",
-            "--apps",
-            "repl",
-            *voici_option,
+            *apps_option,
             "--lite-dir",
             jupyterlite_dir,
         ]
@@ -584,8 +582,8 @@ def jupyterlite_build(app: Sphinx, error):
 
 
 def setup(app):
-    # Initialize RetroLite parser
-    app.add_source_parser(RetroLiteParser)
+    # Initialize NotebookLite parser
+    app.add_source_parser(NotebookLiteParser)
 
     app.connect("config-inited", inited)
     # We need to build JupyterLite at the end, when all the content was created
@@ -603,16 +601,18 @@ def setup(app):
     app.add_config_value("try_examples_global_toolbar", default=None, rebuild=True)
     app.add_config_value("try_examples_global_theme", default=None, rebuild=True)
 
-    # Initialize RetroLite and JupyterLite directives
+    # Initialize NotebookLite and JupyterLite directives
     app.add_node(
-        RetroLiteIframe,
+        NotebookLiteIframe,
         html=(visit_element_html, None),
         latex=(skip, None),
         textinfo=(skip, None),
         text=(skip, None),
         man=(skip, None),
     )
-    app.add_directive("retrolite", RetroLiteDirective)
+    app.add_directive("notebooklite", NotebookLiteDirective)
+    # For backward compatibility
+    app.add_directive("retrolite", NotebookLiteDirective)
     app.add_node(
         JupyterLiteIframe,
         html=(visit_element_html, None),

jupyterlite_sphinx/jupyterlite_sphinx.py

@@ -16,7 +16,7 @@ dependencies = [
     "docutils",
     "jupyter_server",
     "jupyterlab_server",
-    "jupyterlite-core >=0.1.0",
+    "jupyterlite-core >=0.2,<0.3",
     "nbformat",
     "sphinx>=4",
 ]