setup notebook rendering

euro-cordex · Jul 2, 2023 · af01c81 · af01c81
1 parent 80d44ef
commit af01c81
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 5 deletions.
diff --git a/ci/requirements/docs.yml b/ci/requirements/docs.yml
@@ -1,12 +1,10 @@
 name: py-cordex-docs
-
 channels:
   - conda-forge
-  - nodefaults
-
 dependencies:
   - python=3.10
   - pint-xarray
+  - matplotlib-base
   - xarray
   - cf_xarray
   - nbconvert
@@ -20,8 +18,9 @@ dependencies:
   - pooch
   - pyproj
   - sphinx
-  - pydata-sphinx-theme #==0.8.1 # https://github.com/pydata/pydata-sphinx-theme/issues/1098
+  - pydata-sphinx-theme
   - sphinx-book-theme>=0.3.3
   - sphinx-autosummary-accessors
   - pip:
     - sphinxcontrib-mockautodoc
+    - myst_nb
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,7 +2,14 @@
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :hidden:
+   :caption: Tutorial
+
+   notebooks/introduction
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
 
    installation
    usage

diff --git a/docs/notebooks/introduction.ipynb b/docs/notebooks/introduction.ipynb
@@ -0,0 +1,43 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0e348c73-a223-47e6-a056-b3af2be49631",
+   "metadata": {},
+   "source": [
+    "# Introduction"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3ad4b462-d7ae-48ae-89b1-a9da60d64a43",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "1 + 2"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python [conda env:pyremo-test]",
+   "language": "python",
+   "name": "conda-env-pyremo-test-py"
+  },
+  "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.10"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}