docs: add IPython.display import

See ComPWA/policy#49
ComPWA · Feb 6, 2022 · 51084a9 · 51084a9
1 parent a55bcf3
commit 51084a9
Show file tree

Hide file tree

Showing 10 changed files with 85 additions and 86 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -41,18 +41,17 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/ComPWA/repo-maintenance
-    rev: 0.0.102
+    rev: "7351575"
     hooks:
       - id: check-dev-files
         args:
           - --pin-requirements
-      - id: fix-first-nbcell
+      - id: fix-nbformat-version
+      - id: format-setup-cfg
+      - id: set-nb-cells
         args:
           - --add-install-cell
-          - --additional-packages=IPython
           - --extras-require=doc,viz
-      - id: fix-nbformat-version
-      - id: format-setup-cfg
 
   - repo: https://github.com/psf/black
     rev: 22.1.0

diff --git a/docs/usage/amplitude.ipynb b/docs/usage/amplitude.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/dynamics.ipynb b/docs/usage/dynamics.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/dynamics/analytic-continuation.ipynb b/docs/usage/dynamics/analytic-continuation.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/dynamics/custom.ipynb b/docs/usage/dynamics/custom.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/dynamics/k-matrix.ipynb b/docs/usage/dynamics/k-matrix.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/formalism.ipynb b/docs/usage/formalism.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/interactive.ipynb b/docs/usage/interactive.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/modify.ipynb b/docs/usage/modify.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {

diff --git a/docs/usage/symplot.ipynb b/docs/usage/symplot.ipynb
@@ -14,15 +14,14 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell"
+     "remove-cell",
+     "skip-execution"
     ]
    },
    "outputs": [],
    "source": [
-    "%config InlineBackend.figure_formats = ['svg']\n",
-    "import os\n",
-    "\n",
-    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
+    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
+    "%pip install -q ampform[doc,viz]"
    ]
   },
   {
@@ -39,14 +38,15 @@
      "slide_type": "skip"
     },
     "tags": [
-     "remove-cell",
-     "skip-execution"
+     "remove-cell"
     ]
    },
    "outputs": [],
    "source": [
-    "# WARNING: advised to install a specific version, e.g. ampform==0.1.2\n",
-    "%pip install -q ampform[doc,viz] IPython"
+    "%config InlineBackend.figure_formats = ['svg']\n",
+    "import os\n",
+    "\n",
+    "STATIC_WEB_PAGE = {\"EXECUTE_NB\", \"READTHEDOCS\"}.intersection(os.environ)"
    ]
   },
   {