Add pull request CI

Build doc but don't deploy.

Signed-off-by: Jorge Marques <[email protected]>

.github/workflows/build-doc.yml → .github/workflows/main.yml

@@ -1,5 +1,3 @@
-name: Build Doc
-
 on:
   push:
     branches:
@@ -16,7 +14,7 @@ jobs:
 
     steps:
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.x"
 

.github/workflows/pr.yml

@@ -0,0 +1,30 @@
+on:
+  pull_request:
+    paths:
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Build doc
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+
+    - uses: actions/checkout@v4
+      with:
+        lfs: 'true'
+
+    - name: Install pip packages
+      working-directory: docs
+      run: |
+        pip install pip --upgrade
+        pip install -r requirements.txt --upgrade
+
+    - name: Build doc
+      working-directory: docs
+      run: |
+        make html SPHINXOPTS='-W --keep-going'

docs/conf.py

@@ -25,7 +25,7 @@
 intersphinx_mapping = {
     'doctools': ('https://analogdevicesinc.github.io/doctools', None),
     'hdl': ('https://analogdevicesinc.github.io/hdl', None),
-    'no-os': ('https://analogdevicesinc.github.io/no-os', None)
+    'no-OS': ('https://analogdevicesinc.github.io/no-OS', None)
 }
 
 intersphinx_disabled_reftypes = ["*"]