ci: split ci workflow into docs and style

.github/workflows/ci.yml → .github/workflows/ci-docs.yml

@@ -1,6 +1,4 @@
-# cspell:ignore reqs
-
-name: CI
+name: CI-docs
 
 on:
   push:
@@ -26,21 +24,11 @@ jobs:
           sudo apt-get -y install pandoc graphviz
       - name: Build documentation and run notebooks
         working-directory: docs
+        env:
+          EXECUTE_NB: YES
         run: make html
-
-  style:
-    name: Style checks
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+      - uses: actions/upload-artifact@v2
+        if: ${{ always() }}
         with:
-          python-version: 3.7
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r reqs/3.7/requirements-sty.txt
-          pip install .
-      - name: Perform style checks
-        run: pre-commit run -a
+          name: html
+          path: docs/_build/html

.github/workflows/ci-style.yml

@@ -0,0 +1,25 @@
+name: CI-style
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  style:
+    name: Style checks
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r reqs/3.7/requirements-sty.txt
+          pip install .
+      - name: Perform style checks
+        run: pre-commit run -a

.gitignore

@@ -52,5 +52,3 @@ pyvenv*/
 !cspell.json
 !environment.yml
 !pyrightconfig.json
-
-!docs/_static/*

.vscode/settings.json

@@ -63,9 +63,8 @@
   "rewrap.wrappingColumn": 79,
   "search.exclude": {
     "**/tests/**/__init__.py": true,
-    "docs/tox.ini": true,
-    "reqs/3.*/*.txt": true,
-    "tests/tox.ini": true
+    "*/tox.ini": true,
+    "reqs/3.*/*.txt": true
   },
   "telemetry.enableCrashReporter": false,
   "telemetry.enableTelemetry": false

cspell.json

@@ -30,10 +30,10 @@
         ".vscode/*",
         ".vscode/.gitignore",
         "Makefile",
-        "docs/adr/*/*",
         "codecov.yml",
         "cspell.json",
         "docs/_templates/*",
+        "docs/adr/*/*",
         "docs/conf.py",
         "pyproject.toml",
         "pyrightconfig.json",

docs/.gitignore

@@ -3,3 +3,5 @@
 *build/
 api/
 bibliography.bib
+
+!_static/*