Add jupyter image to rtd page; add .readthedocs.yaml

Author: pgleeson

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: Tutorial/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#   - requirements: docs/requirements.txt

README.md

@@ -18,7 +18,7 @@ The latest version of the tutorial is visible [online at ReadTheDocs](http://hod
 
 This interactive [Jupyter notebook](https://jupyter.org/) can be used to run the Python version of the HH model from above, change the parameters of the model and display the dynamical properties of variables, without the need to write any code.
 
-<p align="center"><kbd><a href="https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/notebooks/Python_HH_version/README.md"><img src="https://raw.githubusercontent.com/openworm/hodgkin_huxley_tutorial/master/notebooks/HH_Jupyter.png" width="600"/></kbd></p>
+<p align="center"><kbd><a href="https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/notebooks/Python_HH_version/README.md"><img src="https://raw.githubusercontent.com/openworm/hodgkin_huxley_tutorial/master/Tutorial/_media//HH_Jupyter.png" width="600"/></kbd></p>
 
 Full details can be found [here](https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/notebooks/Python_HH_version/README.md). This work was carried out as part of [Google Summer of Code 2022 by Rahul Sonkar](notebooks/GSoC_2022_Submission/GSoC_Documentation.md).
 

notebooks/HH_Jupyter.png Tutorial/_media/HH_Jupyter.pngnotebooks/HH_Jupyter.png renamed to Tutorial/_media/HH_Jupyter.png

@@ -56,9 +56,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.1'
+version = '0.2.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.1'
+release = '0.2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Tutorial/conf.py

@@ -14,7 +14,19 @@ This tutorial gives an introduction to the `Hodgkin-Huxley model <https://en.wik
 1) Provide `a guide <_static/Tutorial.html>`_ to implementing the Hodgkin-Huxley model using both `Python <https://www.python.org/>`_ and a `NeuroML2 implementation <http://journal.frontiersin.org/Journal/10.3389/fninf.2014.00079/abstract>`_ of the same equations.
 2) Give some background information on the `electrophysiology <_static/Electrophysiology.html>`_ underlying the Hodgkin-Huxley model.
 
-This was originally created by `@joebowen <https://github.com/joebowen>`_ on behalf of the `OpenWorm project <http://www.openworm.org>`_.
+The original HH tutorial was created by `@joebowen <https://github.com/joebowen>`_ on behalf of the `OpenWorm project <http://www.openworm.org>`_.
+
+New interactive introduction to the HH model in a Jupyter notebook
+==================================================================
+
+A new interactive `Jupyter notebook <https://jupyter.org>`_ can be used to run the HH model, change the parameters of the model and display the dynamical properties of variables, without the need to write any code.
+
+.. image:: _media/HH_Jupyter.png
+   :target: https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/notebooks/Python_HH_version/README.md
+
+
+Full details can be found `here <https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/notebooks/Python_HH_version/README.md>`_ with a link to execute the model in your browser. This work was carried out as part of `Google Summer of Code 2022 by Rahul Sonkar <https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/notebooks/GSoC_2022_Submission/GSoC_Documentation.md>`_.
+
 
 What is the Hodgkin-Huxley model?
 =================================

Tutorial/index.rst

@@ -2,7 +2,7 @@
 
 This is an interactive web notebook using [Jupyter technologies](https://jupyter.org/) which can be used to run the HH model, change the parameters of the model and display the dynamical properties of variables.
 
-<p align="center" ><kbd><a href="#running-the-notebook"><img src="../HH_Jupyter.png" width="600"/></a></kbd></p>
+<p align="center" ><kbd><a href="#running-the-notebook"><img src="../../Tutorial/_media/HH_Jupyter.png" width="600"/></a></kbd></p>
 
 This notebook was developed as part of [Google Summer of Code 2022 by Rahul Sonkar](notebooks/GSoC_2022_Submission/GSoC_Documentation.md).