Add CI test for sphinx-intl's doc (#107)

* ci: add test for documentation

* Add sphinx-lint to doc/requirements.txt

* ci: add workflow_dispatch to doc.yml

Allows to call manually the workflow, which is helpful for linkcheck

* Add workflow file to event trigger paths

* Add self to doc/requirements.txt

Needed due to a import of sphinx-intl in doc/conf.py

* Annotate error messages from doc.yml

Author: rffontenelle

.github/workflows/doc.yml

@@ -0,0 +1,49 @@
+name: Docs
+on:
+  push:
+    paths:
+      - 'doc/'
+      - '.github/workflows/doc.yml'
+  pull_request:
+    paths:
+      - 'doc/'
+      - '.github/workflows/doc.yml'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup python binary
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3'
+          cache: 'pip'
+          cache-dependency-path: 'doc/requirements.txt'
+
+      - name: Install dependencies
+        run: pip install -r doc/requirements.txt
+
+      - name: Add sphinx-build problem matcher
+        uses: sphinx-doc/[email protected]
+
+      - name: Add sphinx-lint problem matcher
+        uses: rffontenelle/[email protected]
+
+      - name: Build docs
+        run: make -C doc html O='--keep-going --fail-on-warning --nitpicky'
+
+      - name: Lint docs
+        if: always()
+        run: sphinx-lint doc/
+        
+      - name: Check links
+        if: always()
+        run: make -C doc linkcheck O='--keep-going'

doc/requirements.txt

@@ -1,3 +1,5 @@
 sphinx
 sphinx_rtd_theme>=1.3
 sphinx-click
+sphinx-lint
+.