Automatically check for dirty notebooks in CI (#18)

Add extra steps in CI to automatically check for dirty notebooks. Also
replace outdated SymPDE and Psydac docs with external links to official
documentation.

Author: kvrigor

.github/workflows/build-deploy-book.yml

@@ -71,6 +71,38 @@ jobs:
         pip install --upgrade pip
         pip install -r requirements.txt
 
+    - name: Get list of changed Python notebooks
+      id: changed-ipynb-files
+      uses: tj-actions/changed-files@v45
+      with:
+        files: |
+          **.ipynb
+
+    - name: Check for dirty Python notebooks
+      if: steps.changed-ipynb-files.outputs.any_changed == 'true'
+      env:
+        ALL_CHANGED_FILES: ${{ steps.changed-ipynb-files.outputs.all_changed_files }}
+      run: |
+        # Check if there are dirty notebooks
+        dirty_ipynb=()
+        for file in ${ALL_CHANGED_FILES[*]}; do
+          echo "Checking $file..."
+          if ! nb-clean check $file >/dev/null 2>&1; then
+            dirty_ipynb+=($file)
+          fi
+        done
+
+        # Trigger failure if dirty notebooks were found
+        if [[ ! -z "${dirty_ipynb[@]}" ]]; then
+          echo "ERROR: Found dirty Python notebooks. Please clean the notebooks by running"
+          echo ""
+          echo "nb-clean clean --remove-empty-cells --remove-all-notebook-metadata ${dirty_ipynb[*]}"
+          echo ""
+          exit 1
+        else
+          echo "SUCCESS: All changed notebooks are clean."
+        fi
+
     - name: Build Jupyter Book
       run: make docs
 

_toc.yml

@@ -175,5 +175,8 @@ parts:
       - file: chapter5/multiphysics
   - caption: Documentation
     chapters:
-      - file: documentation/sympde
-      - file: documentation/psydac
+    - url: https://pyccel.github.io/psydac/index.html
+      title: Psydac
+    - url: https://sympde.readthedocs.io/en/latest/
+      title: SymPDE
+