ENH: Custom README accessible as ipynb

ContactEngineering · Sep 23, 2023 · 40ce3b1 · 40ce3b1
1 parent 8663ae5
commit 40ce3b1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 11 deletions.
diff --git a/docker/jupyterlab-SurfaceTopography/Dockerfile b/docker/jupyterlab-SurfaceTopography/Dockerfile
@@ -5,13 +5,6 @@ FROM jupyter/minimal-notebook:python-3.11.5
 
 USER root
 
-COPY --chown=${NB_UID}:${NB_GID} jupyterlab-SurfaceTopography/conda-requirements.in "/home/${NB_USER}/"
-RUN pip install pip-tools
-RUN pip-compile "/home/${NB_USER}/conda-requirements.in" > "/home/${NB_USER}/conda-requirements.txt"
-RUN pip install --quiet --no-cache-dir --requirement "/home/${NB_USER}/conda-requirements.txt" && \
-    fix-permissions "${CONDA_DIR}" && \
-    fix-permissions "/home/${NB_USER}"
-
 # FROM imkteksim/dtool-jupyter:latest
 # Install from requirements.txt file
 RUN apt-get --yes update && \
@@ -31,6 +24,13 @@ RUN apt-get --yes update && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
+COPY --chown=${NB_UID}:${NB_GID} jupyterlab-SurfaceTopography/conda-requirements.in "/home/${NB_USER}/"
+RUN pip install pip-tools
+RUN pip-compile "/home/${NB_USER}/conda-requirements.in" > "/home/${NB_USER}/conda-requirements.txt"
+RUN pip install --quiet --no-cache-dir --requirement "/home/${NB_USER}/conda-requirements.txt" && \
+    fix-permissions "${CONDA_DIR}" && \
+    fix-permissions "/home/${NB_USER}"
+
 # Workaround for building packages and introducing an ipykernel outside of the jupyterlab conda environment
 RUN PATH=$(echo "$PATH" | sed -e 's|/opt/conda[^:]*:||g') && ( \
         pip install meson ninja && \
@@ -73,5 +73,7 @@ COPY --chown=${NB_UID}:${NB_GID} jupyterlab-SurfaceTopography/etc/jupyter_app_la
 
 # Copy README.md
 COPY --chown=${NB_UID}:${NB_GID} jupyterlab-SurfaceTopography/README.md "/home/${NB_USER}/README.md"
+RUN pandoc "/home/${NB_USER}/README.md" -o "/home/${NB_USER}/README.html"
+RUN md2nb "/home/${NB_USER}/README.md"
 
 CMD ["start-wrapper.sh", "start-notebook.sh"]
diff --git a/docker/jupyterlab-SurfaceTopography/conda-requirements.in b/docker/jupyterlab-SurfaceTopography/conda-requirements.in
@@ -2,4 +2,4 @@ jupyterlab_autorun_cells
 jupytext
 jupyterlab-tour
 jupyter-app-launcher
-
+md2nb
diff --git a/docker/jupyterlab-SurfaceTopography/etc/jupyter_app_launcher/config.yaml b/docker/jupyterlab-SurfaceTopography/etc/jupyter_app_launcher/config.yaml
@@ -1,7 +1,8 @@
 - title: README
-  description: jupyterlab-SurfaceTopography container README.md
-  source: ../../README.md
-  type: markdown
+  description: jupyterlab-SurfaceTopography container README
+  source: ../../README.ipynb
+  cwd: ../../
+  type: notebook
   catalog: Help
 
 - title: SurfaceTopography docs