Configure JupyterLite

Author: IsabelParedes

docs/conf.py

@@ -36,6 +36,7 @@
     'myst_parser',
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'jupyterlite_sphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -61,3 +62,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # html_static_path = ['_static']
+
+# JupyterLite
+jupyterlite_contents = ["robotLite.urdf", "notebook.ipynb"]
+jupyterlite_dir = "."

docs/index.rst

@@ -11,6 +11,8 @@ With this JupyterLab extension, you can easily create and modify URDF files from
 .. image:: _static/urdfOverview.gif
    :alt: Functionality of extension
 
+.. retrolite:: notebook.ipynb
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

docs/jupyterlite_config.json

@@ -0,0 +1,8 @@
+{
+    "LiteBuildConfig": {
+        "federated_extensions": [
+            "https://anaconda.org/conda-forge/jupyterlab-urdf/0.1.0a0/download/noarch/jupyterlab-urdf-0.1.0a0-pyhd8ed1ab_0.tar.bz2"
+        ],
+        "ignore_sys_prefix": true
+    }
+}

docs/notebook.ipynb

@@ -0,0 +1,33 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f5b0e5cc-c84f-46fe-8297-c437dc4c18e5",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.13"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/robotLite.urdf

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<robot name="robot">
+    <link name="base_link">
+        <visual>
+            <geometry>
+                <cylinder length="1" radius="0.25"/>
+            </geometry>
+            <origin rpy="0 0 0" xyz="0 0 0.5"/>
+        </visual>
+    </link>
+    
+    <joint name="base_to_plate" type="prismatic">
+        <parent link="base_link"/>
+        <child link="plate"/>
+        <origin rpy="0 0 0" xyz="0 0 0"/>
+        <axis xyz="0 0 1"/>
+        <limit effort="1000.0" lower="0" upper="1" velocity="0.5"/>
+    </joint>
+    
+    <link name="plate">
+        <visual>
+            <geometry>
+                <box size="0.7 0.7 0.05"/>
+            </geometry>
+            <origin rpy="0 0 0" xyz="0 0 0.025"/>
+        </visual>
+    </link>
+</robot>