diff options
| author | David Smith <smithdc@gmail.com> | 2025-08-08 07:34:35 +0100 |
|---|---|---|
| committer | nessita <124304+nessita@users.noreply.github.com> | 2025-08-08 16:39:50 -0300 |
| commit | 7a80e29feaa675a27bf525164502ebc8ecbdce1a (patch) | |
| tree | 021ba37373d125bffb6b8dc9846e52cd9bb75ed1 /.github | |
| parent | c1aa4a7a79a56fa46793d128bcf42795e2149595 (diff) | |
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
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/docs.yml | 4 |
1 files 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 |