Trying to add notebooks into the examples. Most probably will fail in readthedocs server.

.readthedocs.yaml

@@ -6,6 +6,7 @@ build:
     python: "3.8"
   apt_packages:
     - libgeos-dev
+    - pandoc
 
 python:
   # Install our python package before building the docs

docs/Makefile

@@ -16,6 +16,9 @@ help:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: Makefile examples
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+examples:
+	cp ../examples/notebooks/*ipynb source/examples/examples_api
+

docs/requirements.txt

@@ -3,4 +3,6 @@ sphinxcontrib-autoprogram
 sphinx_design
 sphinx_rtd_theme
 sphinx-copybutton
+nbsphinx
+ipykernel
 

docs/source/conf.py

@@ -28,11 +28,21 @@ extensions = [
     'sphinx_design',
     'numpydoc',
     'sphinx_copybutton',
+    'nbsphinx',
+    'IPython.sphinxext.ipython_console_highlighting'
 ]
 
+exclude_patterns = ['_build', '**.ipynb_checkpoints']
+
+
 # Flag to allow errors in the nbsphinx thingy
 nbsphinx_allow_errors = True
 
+# Set the kernel
+nbsphinx_kernel_name = 'python3'
+
+
+
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),
     'sphinx': ('https://www.sphinx-doc.org/en/master/', None),

docs/source/examples/examples_api.rst → docs/source/examples/examples_api/index.rst

 .. _ExamplesAPI:
 
-Python API examples
---------------------
+Jupyter Notebooks
+=================
+
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    compress_file.ipynb
+
+More Python API examples
+========================
 
 Few examples are available in our `github repository <https://github.com/wavestoweather/enstools-compression/tree/main/examples>`_.

docs/source/examples/index.rst

@@ -11,10 +11,10 @@ Examples
 
         .. image:: ../images/icons/api.svg
             :width: 50%
-            :alt: Alternative text
+            :alt: API
             :align: center
 
-        .. button-ref:: examples_api
+        .. button-ref:: examples_api/index
             :expand:
             :color: secondary
             :click-parent:
@@ -26,7 +26,7 @@ Examples
 
         .. image:: ../images/icons/cli.svg
             :width: 50%
-            :alt: Alternative text
+            :alt: CLI
             :align: center
 
 
@@ -41,5 +41,5 @@ Examples
     :maxdepth: 2
     :hidden:
 
-    examples_api.rst
+    examples_api/index.rst
     examples_cli.rst
\ No newline at end of file