ci: include docs directory in linting

IATI · Oct 3, 2024 · ab9e62b · ab9e62b
1 parent 5b56a7c
commit ab9e62b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 16 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,15 +5,17 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.10'
-    - name: Install dev requirements
-      run: pip install -r requirements_dev.txt
-    - name: Check black
-      run: black --check iati_sphinx_theme
-    - name: Check isort
-      run: isort --check-only iati_sphinx_theme
-    - name: Check flake8
-      run: flake8 iati_sphinx_theme
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dev requirements
+        run: pip install -r requirements_dev.txt
+      - name: Check black
+        run: black --check iati_sphinx_theme docs
+      - name: Check isort
+        run: isort --check-only iati_sphinx_theme docs
+      - name: Check flake8
+        run: flake8 iati_sphinx_theme docs
+      - name: Check mypy
+        run: mypy iati_sphinx_theme docs
diff --git a/README.md b/README.md
@@ -22,10 +22,10 @@ pip install -r requirements_dev.txt
 ### Run linting
 
 ```
-black iati_sphinx_theme/
-isort iati_sphinx_theme/
-flake8 iati_sphinx_theme/
-mypy iati_sphinx_theme/
+black iati_sphinx_theme/ docs/
+isort iati_sphinx_theme/ docs/
+flake8 iati_sphinx_theme/ docs/
+mypy iati_sphinx_theme/ docs/
 ```
 
 ### Documentation with live preview