Merge pull request #415 from mir-group/weekly-build

add a weekly build to github actions workflow

.github/workflows/flare.yml

@@ -1,12 +1,16 @@
-# Adapted from: https://github.com/satu0king/Github-Documentation-With-Doxygen
-# This is a basic workflow to help you get started with Actions
-
 name: flare
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * 0'
 
 jobs:
-  # This workflow contains a single job called "build"
   build:
     strategy:
       matrix:
@@ -15,17 +19,14 @@ jobs:
         python-version: ["3.7", "3.8"]
     name: "(OpenMP, Lapack, Python) ="
 
-    # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
     env:
       BUILD_DIR: build_${{ matrix.omp }}_${{ matrix.lapack }}
       CC: gcc-9
       CXX: g++-9
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
@@ -121,10 +122,8 @@ jobs:
     - name: Run Doxygen
       uses: mattnotmitt/[email protected]
       with:
-        # Path to Doxyfile
-        doxyfile-path: "./Doxyfile" # default is ./Doxyfile
-        # Working directory
-        working-directory: "./docs" # default is .
+        doxyfile-path: "./Doxyfile"
+        working-directory: "./docs"
 
     - name: Run Sphinx
       run: |
@@ -139,7 +138,5 @@ jobs:
       uses: peaceiris/actions-gh-pages@v4
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        # Default Doxyfile build documentation to html directory.
-        # Change the directory if changes in Doxyfile
         publish_dir: ./docs/build/html
       if: github.event_name == 'pull_request' && matrix.lapack == 'on' && matrix.omp == 'on'