Merge pull request #292 from JohnGriffiths/add-smart-ci-buildcache

Add smart ci buildcache

Author: JohnGriffiths

.github/workflows/docs.yml

@@ -10,28 +10,70 @@ jobs:
   build:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout repo
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0   
+        
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
         python-version: 3.8
+        
     - name: Install dependencies
       run: |
         make install-deps-apt
         python -m pip install --upgrade pip wheel
         python -m pip install attrdict
 
         make install-deps-wxpython
+        
     - name: Build project
       run: |
         make install-docs-build-dependencies
 
+
+    - name: Get list of changed files
+      id: changes
+      run: |
+        git fetch origin master
+        git diff --name-only origin/master...HEAD > changed_files.txt
+        cat changed_files.txt
+
+
+    - name: Determine build mode
+      id: mode
+      run: |
+        if grep -vqE '^examples/.*\.py$' changed_files.txt; then
+          echo "FULL_BUILD=true" >> $GITHUB_ENV
+          echo "Detected non-example file change. Full build triggered."
+        else
+          CHANGED_EXAMPLES=$(grep '^examples/.*\.py$' changed_files.txt | paste -sd '|' -)
+          echo "FULL_BUILD=false" >> $GITHUB_ENV
+          echo "CHANGED_EXAMPLES=$CHANGED_EXAMPLES" >> $GITHUB_ENV
+          echo "Changed examples: $CHANGED_EXAMPLES"
+        fi
+
+
+    - name: Cache built documentation
+      id: cache-docs
+      uses: actions/cache@v4
+      with:
+        path: |
+          doc/_build/html
+        key: ${{ runner.os }}-sphinx-${{ hashFiles('examples/**/*.py', 'doc/**/*', 'conf.py') }}
+        restore-keys: |
+          ${{ runner.os }}-sphinx-
+
+
     - name: Build docs
       run: |
         make docs
+
+        
     - name: Deploy Docs
       uses: peaceiris/actions-gh-pages@v3
       if: github.ref == 'refs/heads/master'  # TODO: Deploy seperate develop-version of docs?
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: doc/_build/html
+        publish_dir: doc/_build/html

doc/conf.py

@@ -288,3 +288,19 @@ def setup(app):
 }
 
 """
+
+import os
+
+changed_examples = os.getenv('CHANGED_EXAMPLES')
+full_build = os.getenv('FULL_BUILD', 'true').lower() == 'true'
+
+if not full_build and changed_examples:
+    print(f"Only building examples matching: {changed_examples}")
+    sphinx_gallery_conf.update({
+        'filename_pattern': changed_examples,
+    })
+else:
+    print("Building all examples (full build).")
+    sphinx_gallery_conf.update({
+        'filename_pattern': '(?=.*r__)(?=.*.py)',  # r'.*\.py',
+    })

examples/visual_n170/01r__n170_viz.py

@@ -110,7 +110,7 @@
 # reordering of epochs.ch_names according to [[0,2],[1,3]] of subplot axes
 
 # Manually adjust the ylims
-for i in [0,2]: ax[i].set_ylim([-0.5e6,0.5e6])
-for i in [1,3]: ax[i].set_ylim([-1.5e6,2.5e6])
+#for i in [0,2]: ax[i].set_ylim([-0.5e6,0.5e6])
+#for i in [1,3]: ax[i].set_ylim([-1.5e6,2.5e6])
 plt.tight_layout()