From 985dfc299d662e7104bf7e8bafcba0ea2dbf0bbe Mon Sep 17 00:00:00 2001
From: Maarten Sebregts <msebregts@ignitioncomputing.com>
Date: Mon, 23 Mar 2026 11:31:12 +0100
Subject: [PATCH 1/2] Enable readthedocs `fail_on_warning`

Current build succeeds without warnings. Enabling this may avoid issues with the documentation in the future.
---
 .readthedocs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.readthedocs.yml b/.readthedocs.yml
index 426920c7..05ae2765 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -20,4 +20,4 @@ python:
 sphinx:
   builder: html
   configuration: docs/source/conf.py
-  fail_on_warning: false
\ No newline at end of file
+  fail_on_warning: true

From 201180992480097150aeda5030b6eb8bade4d687 Mon Sep 17 00:00:00 2001
From: Maarten Sebregts <msebregts@ignitioncomputing.com>
Date: Mon, 23 Mar 2026 11:38:42 +0100
Subject: [PATCH 2/2] Set nitpicky mode in conf.py

And remove superfluous `verify_sphinx_doc.yml` workflow: this is checked by the ReadTheDocs integration
---
 .github/workflows/verify_sphinx_doc.yml | 53 -------------------------
 docs/source/conf.py                     |  3 ++
 2 files changed, 3 insertions(+), 53 deletions(-)
 delete mode 100644 .github/workflows/verify_sphinx_doc.yml

diff --git a/.github/workflows/verify_sphinx_doc.yml b/.github/workflows/verify_sphinx_doc.yml
deleted file mode 100644
index 6a12690e..00000000
--- a/.github/workflows/verify_sphinx_doc.yml
+++ /dev/null
@@ -1,53 +0,0 @@
-name: verify-sphinx-doc-generation
-
-on:
-  push:
-  pull_request:
-    types: [opened, synchronize, reopened]
-
-jobs:
-  build-and-test:
-    runs-on: ubuntu-22.04
-
-    steps:
-      - name: Checkout IMAS-Python sources
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          with:
-          # until saxonche is available in 3.13
-          # https://saxonica.plan.io/issues/6561
-          python-version: "<3.13"
-
-      - name: Display Python version
-        run: python -c "import sys; print(sys.version)"
-
-
-      - name: Set up Python virtual environment
-        run: |
-          python -m venv venv
-          source venv/bin/activate
-
-      - name: Install build dependencies
-        run: |
-          pip install --upgrade pip setuptools wheel build
-
-      - name: Build package
-        run: |
-          rm -rf dist
-          python -m build .
-
-      - name: Install package and dependencies
-        run: |
-          pip install "$(readlink -f dist/*.whl)[docs,netcdf]"
-
-      - name: Debug dependencies
-        run: |
-          pip freeze
-
-      - name: Build Sphinx documentation
-        run: |
-          export SPHINXOPTS='-W -n --keep-going'
-          make -C docs clean html
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 06f59e76..f5a8a205 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -34,6 +34,9 @@
 author = "ITER Organization"
 src_host = "https://github.com/iterorganization/"
 
+# Warn about missing references
+nitpicky = True
+
 # Parse urls here for convenience, to be re-used
 # ITER docs
 iter_projects = "https://github.com/iterorganization/"