From 28a86a1d3b50796cb6f617cc97657a2f7b3eb026 Mon Sep 17 00:00:00 2001 From: Martin Lehmann Date: Thu, 22 Feb 2024 15:17:59 +0100 Subject: [PATCH] docs: Treat Sphinx warnings as errors This should help find issues with the documentation early, before it lands on master and has a chance to accumulate. For this, we also re-enable documentation builds on pull requests. --- .github/workflows/docs.yml | 1 + docs/Makefile | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ad0900d1f..3b7de74c4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -7,6 +7,7 @@ on: workflow_dispatch: push: branches: [master] + pull_request: jobs: sphinx: diff --git a/docs/Makefile b/docs/Makefile index d3517447a..fc177fe52 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,7 +6,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= +SPHINXOPTS ?= -W SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = build