Merge remote-tracking branch 'origin/release'

Author: Edly

README.rst

@@ -1,38 +1,46 @@
 Jupyter Notebook plugin for `Tutor <https://docs.tutor.edly.io>`__
-======================================================================
+===================================================================
 
 This is a plugin for Tutor that makes it easy to integrate `Jupyter <https://jupyter.org/>`__ notebooks in `Open edX <https://openedx.org>`__. It achieves the following:
 
 1. Install the official `jupyter-xblock <https://github.com/overhangio/jupyter-xblock/>`__ in the Open edX LMS and Studio.
 2. Run a Docker-based `JupyterHub <https://jupyterhub.readthedocs.io/en/stable/>`__ instance with a `Docker spawner <https://jupyterhub-dockerspawner.readthedocs.io/en/latest/>`__.
 
-In pratice, it means that students will be allocated Docker containers with limited CPU and memory to run their custom notebooks.
+In practice, it means that students will be allocated Docker containers with limited CPU and memory to run their custom notebooks.
 
 ⚠️ Compatibility with Kubernetes was not battle-tested. Please report any issue you face. For a more production-ready Kubernetes environment, you are encouraged to check the documentation of the `Zero to JupyterHub with Kubernetes <https://z2jh.jupyter.org/en/stable/resources/reference.html>`__ project.
 
 Installation
 ------------
 
-::
+.. code-block:: bash
 
     tutor plugins install jupyter
 
 Usage
 -----
 
-Enable the plugin::
+Enable the plugin:
+
+.. code-block:: bash
 
     tutor plugins enable jupyter
 
-Re-build the "openedx" Docker image to install the Jupyter XBlock::
+Re-build the "openedx" Docker image to install the Jupyter XBlock:
+
+.. code-block:: bash
 
     tutor images build openedx
 
-Launch your platform again::
+Launch your platform again:
+
+.. code-block:: bash
 
     tutor local launch
 
-Print the default passport ID::
+Print the default passport ID:
+
+.. code-block:: bash
 
     echo "$(tutor config printvalue JUPYTER_DEFAULT_PASSPORT_ID):$(tutor config printvalue JUPYTER_LTI_CLIENT_KEY):$(tutor config printvalue JUPYTER_LTI_CLIENT_SECRET)"
 
@@ -41,7 +49,6 @@ Make a note of the printed value. Go to the Studio Tools ➡️ Advanced Setting
 .. image:: https://raw.githubusercontent.com/overhangio/jupyter-xblock/main/static/screenshots/studio-advanced-settings-lti.png
      :alt: Studio advanced settings
 
-
 In "Advanced Module List" add "jupyter" (with quotes):
 
 .. image:: https://raw.githubusercontent.com/overhangio/jupyter-xblock/main/static/screenshots/studio-advanced-settings.png
@@ -84,7 +91,9 @@ Unique, user-specific settings:
 JupyterHub
 ~~~~~~~~~~
 
-The configuration template for the JupyterHub instance is stored in `jupyterhub_config.py <./tutorjupyter/templates/jupyter/apps/jupyterhub_config.py>`__. This template file includes a ``{{ patch("jupyterhub-config") }}`` statement, which means that its contents can be overridden by creating an ad-hoc Tutor plugin. For instance, to add custom LTI keys to your JupyterHub instance::
+The configuration template for the JupyterHub instance is stored in `jupyterhub_config.py <./tutorjupyter/templates/jupyter/apps/jupyterhub_config.py>`__. This template file includes a ``{{ patch("jupyterhub-config") }}`` statement, which means that its contents can be overridden by creating an ad-hoc Tutor plugin. For instance, to add custom LTI keys to your JupyterHub instance:
+
+.. code-block::python
 
     from tutor import hooks
 
@@ -98,7 +107,9 @@ The configuration template for the JupyterHub instance is stored in `jupyterhub_
         )
     )
 
-To modify the "jupyterhub" Docker image and add extra Python packages (for example), you should create a Tutor plugin that implements the "jupyterhub-dockerfile" patch::
+To modify the "jupyterhub" Docker image and add extra Python packages (for example), you should create a Tutor plugin that implements the "jupyterhub-dockerfile" patch:
+
+.. code-block::python
 
     from tutor import hooks
 
@@ -112,15 +123,19 @@ To modify the "jupyterhub" Docker image and add extra Python packages (for examp
         )
     )
 
-Then build the JupyterHub image again::
+Then build the JupyterHub image again:
+
+.. code-block:: bash
 
     tutor config save
     tutor images build jupyterhub
 
 Lab environment
 ~~~~~~~~~~~~~~~
 
-By default, Jupyter lab notebooks will be spawned that do not include extra Python packages or dependencies. To modify the "jupyterlab" Docker image and add extra Python packages (for example), you should create a Tutor plugin that implements the "jupyterlab-dockerfile" patch::
+By default, Jupyter lab notebooks will be spawned that do not include extra Python packages or dependencies. To modify the "jupyterlab" Docker image and add extra Python packages (for example), you should create a Tutor plugin that implements the "jupyterlab-dockerfile" patch:
+
+.. code-block::python
 
     from tutor import hooks
 
@@ -134,7 +149,9 @@ By default, Jupyter lab notebooks will be spawned that do not include extra Pyth
         )
     )
 
-Then build the lab image again::
+Then build the lab image again:
+
+.. code-block:: bash
 
     tutor config save
     tutor images build jupyterlab