From 7a80e29feaa675a27bf525164502ebc8ecbdce1a Mon Sep 17 00:00:00 2001 From: David Smith Date: Fri, 8 Aug 2025 07:34:35 +0100 Subject: [PATCH] Improved docs.yml GitHub Action covering docs quality checks. This change renames the `docs` job to `spelling` to better reflect its purpose. It also removes the unused `--keep-going` flag, since starting with Sphinx 8.1, `--keep-going` is enabled by default. See: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 46c2cf8707..df183a5c42 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,7 +22,7 @@ permissions: jobs: docs: runs-on: ubuntu-24.04 - name: docs + name: spelling steps: - name: Checkout uses: actions/checkout@v4 @@ -36,7 +36,7 @@ jobs: - name: Build docs run: | cd docs - sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling + sphinx-build -b spelling -n -q -W -d _build/doctrees -D language=en_US -j auto . _build/spelling blacken-docs: runs-on: ubuntu-latest