fix workflows (#237)

* ruff docs checks all the time

* check code in docs for every main pushes

* check docs more often

* check notebook more often

* remove auto publish for now

.github/workflows/docs-checker.yaml

@@ -1,11 +1,9 @@
-name: spellcheck & README link checker
+name: spellcheck & link checker
+
 on:
   push:
-    paths:
-      - 'docs/**'
-      - 'README.md'
-      - '.github/.pyspelling.yaml'
-      - '.github/lavague-dic.txt'
+  schedule:
+    - cron: '20 8,17 * * *'
 
 jobs:
   spellcheck:
@@ -30,7 +28,7 @@ jobs:
       - name: Spellcheck Markdown files
         run: |
           pyspelling -c .github/.pyspelling.yaml
-  
+
   check-README-links:
     runs-on: ubuntu-latest
     steps:
@@ -42,11 +40,26 @@ jobs:
 
       - name: Check links in README.md
         run: markdown-link-check README.md
+
+  check-docs-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y linkchecker
+
+      - name: Check links
+        id: linkcheck
+        run: linkchecker https://docs.lavague.ai/en/latest/
 
   notify:
     runs-on: ubuntu-latest
     needs: check-README-links
-    if: ${{ failure() || needs.check-README-links.outcome == 'failure' }}
+    if: ${{ failure() || needs.check-README-links.outcome == 'failure' || needs.check-docs-links.outcome == 'failure' }}
     steps:
       - name: Send failure notification via Discord
         uses: Ilshidur/action-discord@0c4b27844ba47cb1c7bee539c8eead5284ce9fa9

.github/workflows/docs-code.yaml

@@ -1,13 +1,9 @@
-name: Python Code Check
+name: Python Code Check in docs and README
 
 on:
   push:
     branches:
       - main
-    paths:
-      - 'README.md'
-      - 'docs/index.md'
-      - 'pyproject.toml'
 
 jobs:
   check-code:
@@ -41,11 +37,30 @@ jobs:
     - name: Run the Python script
       run: |
         python check-code.py
+    
+  execute-notebook:
+    runs-on: ubuntu-latest
+    env:
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10' 
+
+    - name: Install Python dependencies and nbconvert
+      run: pip install notebook nbconvert lavague
+
+    - name: Execute the notebook
+      run: jupyter nbconvert --to notebook --execute --inplace --output executed_notebook.ipynb docs/docs/get-started/quick-tour-notebook/quick-tour.ipynb
 
   notify:
     runs-on: ubuntu-latest
     needs: [ check-code]
-    if: ${{ failure() || needs.check-code.outcome == 'failure' }}
+    if: ${{ failure() || needs.check-code.outcome == 'failure' || needs.execute-notebook.outcome == 'failure'}}
     steps:
       - name: Send failure notification via Discord
         uses: Ilshidur/action-discord@0c4b27844ba47cb1c7bee539c8eead5284ce9fa9

.github/workflows/codebase-test.yaml → .github/workflows/format.yaml

@@ -1,13 +1,11 @@
-name: Software test, formatting & publishing
+name: Formatting
 
 on:
   push:
-    paths:
-      - 'src/lavague/**.py'
 
 jobs:
-  lint:
-    name: Run Ruff Linter
+  format:
+    name: Run Ruff format checker
     runs-on: ubuntu-latest
 
     steps:
@@ -22,8 +20,5 @@ jobs:
     - name: Install Ruff
       run: pip install ruff
 
-    - name: Run Ruff on src/lavague
-      run: ruff format .
-
-    - name: Run Ruff on examples
-      run: ruff format examples/
+    - name: Run ruff
+      run: ruff format --check .