Add run script for documentation

Author: blankjul

docs/run.py

@@ -0,0 +1,19 @@
+from jupyter_client.manager import start_new_kernel
+
+from tests.test_util import files_from_folder, run_ipynb, DOCS
+
+SKIP = ["parallelization.ipynb",
+        "video.ipynb",
+        "modact.ipynb",
+        "dascmop.ipynb"]
+
+IPYNBS = [e for e in files_from_folder(DOCS, regex='**/*.ipynb', skip=SKIP) if ".ipynb_checkpoints" not in e]
+
+for ipynb in IPYNBS:
+    print(ipynb, end="")
+    try:
+        KERNEL = start_new_kernel(kernel_name='python3')
+        run_ipynb(KERNEL, ipynb, overwrite=True, remove_trailing_empty_cells=True)
+        print(" OK")
+    except:
+        print(" FAIL")

docs/source/algorithms/usage.ipynb

@@ -3,10 +3,10 @@
   {
    "cell_type": "raw",
    "metadata": {
-    "raw_mimetype": "text/restructuredtext",
     "pycharm": {
      "name": "#%% raw\n"
-    }
+    },
+    "raw_mimetype": "text/restructuredtext"
    },
    "source": [
     ".. _nb_algorithms_usage:"
@@ -26,10 +26,10 @@
   {
    "cell_type": "raw",
    "metadata": {
-    "raw_mimetype": "text/restructuredtext",
     "pycharm": {
      "name": "#%% raw\n"
-    }
+    },
+    "raw_mimetype": "text/restructuredtext"
    },
    "source": [
     ".. admonition:: Overview\n",
@@ -43,10 +43,10 @@
   {
    "cell_type": "raw",
    "metadata": {
-    "raw_mimetype": "text/restructuredtext",
     "pycharm": {
      "name": "#%% raw\n"
-    }
+    },
+    "raw_mimetype": "text/restructuredtext"
    },
    "source": [
     ".. _nb_algorithms_func:"
@@ -141,10 +141,10 @@
   {
    "cell_type": "raw",
    "metadata": {
-    "raw_mimetype": "text/restructuredtext",
     "pycharm": {
      "name": "#%% raw\n"
-    }
+    },
+    "raw_mimetype": "text/restructuredtext"
    },
    "source": [
     ".. _nb_algorithms_object:"
@@ -175,10 +175,10 @@
   {
    "cell_type": "raw",
    "metadata": {
-    "raw_mimetype": "text/restructuredtext",
     "pycharm": {
      "name": "#%% raw\n"
-    }
+    },
+    "raw_mimetype": "text/restructuredtext"
    },
    "source": [
     ".. _nb_algorithms_next:"
@@ -282,10 +282,10 @@
   {
    "cell_type": "raw",
    "metadata": {
-    "raw_mimetype": "text/restructuredtext",
     "pycharm": {
      "name": "#%% raw\n"
-    }
+    },
+    "raw_mimetype": "text/restructuredtext"
    },
    "source": [
     ".. _nb_algorithms_ask_and_tell:"

docs/source/api/index.rst

@@ -6,4 +6,3 @@ API Reference
 
    model
    algorithms
-   factory