Merge pull request #18 from martinRenou/retrolite_tree

Retrolite directive: Show tree if no Notebook specified

Author: martinRenou

docs/index.rst

@@ -62,6 +62,19 @@ It takes the name of the Notebook as argument:
    :width: 100%
    :height: 600px
 
+Or you can simply show the filetree:
+
+.. code-block:: rst
+
+    .. retrolite::
+       :width: 100%
+       :height: 600px
+
+.. retrolite::
+   :width: 100%
+   :height: 600px
+
+
 JupyterLab and RetroLab deployed for you
 ----------------------------------------
 

src/jupyterlite_sphinx.py

@@ -106,8 +106,14 @@ def __init__(
     def html(self):
         notebook = self["notebook"]
 
+        src = (
+            f"{JUPYTERLITE_DIR}/retro/notebooks/?path={notebook}"
+            if notebook is not None
+            else f"{JUPYTERLITE_DIR}/retro"
+        )
+
         return (
-            f'<iframe src="{JUPYTERLITE_DIR}/retro/notebooks/?path={notebook}"'
+            f'<iframe src="{src}"'
             f'width="{self["width"]}" height="{self["height"]}" style="{IFRAME_STYLE}"></iframe>'
         )
 
@@ -119,31 +125,34 @@ class RetroliteDirective(SphinxDirective):
     """
 
     has_content = False
-    required_arguments = 1
+    optional_arguments = 1
     option_spec = {
         "width": directives.unchanged,
         "height": directives.unchanged,
     }
 
     def run(self):
-        notebook = self.arguments[0]
+        width = self.options.get("width", "100%")
+        height = self.options.get("height", "1000px")
 
-        # If we didn't get an absolute path,
-        # try to find the Notebook relatively to the source
-        if not os.path.isabs(notebook):
-            source_location = os.path.dirname(self.get_source_info()[0])
-            notebook = os.path.join(source_location, notebook)
+        if self.arguments:
+            notebook = self.arguments[0]
 
-        notebook_name = os.path.basename(notebook)
+            # If we didn't get an absolute path,
+            # try to find the Notebook relatively to the source
+            if not os.path.isabs(notebook):
+                source_location = os.path.dirname(self.get_source_info()[0])
+                notebook = os.path.join(source_location, notebook)
 
-        width = self.options.get("width", "100%")
-        height = self.options.get("height", "1000px")
+            notebook_name = os.path.basename(notebook)
 
-        notebooks_dir = Path(self.env.app.srcdir) / CONTENT_DIR / notebook_name
+            notebooks_dir = Path(self.env.app.srcdir) / CONTENT_DIR / notebook_name
 
-        # Copy the Notebook for RetroLite to find
-        os.makedirs(os.path.dirname(notebooks_dir), exist_ok=True)
-        shutil.copyfile(notebook, str(notebooks_dir))
+            # Copy the Notebook for RetroLite to find
+            os.makedirs(os.path.dirname(notebooks_dir), exist_ok=True)
+            shutil.copyfile(notebook, str(notebooks_dir))
+        else:
+            notebook_name = None
 
         return [RetroliteIframe(notebook=notebook_name, width=width, height=height)]