Update and enhance nbtutorial builder (#205)

- Update `nbtutorial` builder to use the `nbformat` library to write notebooks. - Preparations in order to support tutorial solutions - Fix the `clean-notebook` commit hook's handling of checking many notebooks
swyddfa · Mar 23, 2020 · e3e5fc2 · e3e5fc2
1 parent e5f9fcf
commit e3e5fc2
Show file tree

Hide file tree

Showing 44 changed files with 714 additions and 290 deletions.
diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml
@@ -30,7 +30,7 @@ jobs:
         python --version
 
         python -m pip install --upgrade pip
-        python -m pip install -e .
+        python -m pip install -e .[doc]
         python -m pip install -r docs/requirements.txt
 
     - name: Build Docs

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -37,5 +37,6 @@
         "editor.rulers": [
             79
         ]
-    }
+    },
+    "restructuredtext.linter.disabled": true
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -31,6 +31,16 @@
                 "cwd": "${workspaceRoot}"
             }
         },
+        {
+            "label": "Build Tutorial",
+            "type": "shell",
+            "command": "source ${workspaceRoot}/.dev/bin/activate && sphinx-build -M nbtutorial docs/ docs/_build/ -E -a",
+            "problemMatcher": [],
+            "group": "build",
+            "options": {
+                "cwd": "${workspaceRoot}"
+            }
+        },
         {
             "label": "Edit Gallery",
             "type": "shell",
@@ -104,6 +114,16 @@
                 "cwd": "${workspaceRoot}/.scratch"
             }
         },
+        {
+            "label": "Open Tutorial",
+            "type": "shell",
+            "command": "source ${workspaceRoot}/.dev/bin/activate && jupyter-lab",
+            "problemMatcher": [],
+            "group": "build",
+            "options": {
+                "cwd": "${workspaceRoot}/docs/_build/nbtutorial/users"
+            }
+        },
         {
             "label": "Test File",
             "type": "shell",

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -18,7 +18,9 @@ v0.0.4 - 2020-02-15
 
 Added
 ^^^^^
+
 - The concept of a :code:`Definition`.
+
   + This incorporates the existing concept of a :code:`Shape` and expands on it
     to cover input parameters and more
   + Definitions can be derived from other definitions by passing in existing
-Original file line number
+Diff line change
@@ Expand Up / @@ -37,5 +37,6 @@ @@
             "editor.rulers": [
             ]
-        }
+        },
+        "restructuredtext.linter.disabled": true
     }