From 43e4d0a1422d87cc804097f7eb127b6ffa07e840 Mon Sep 17 00:00:00 2001 From: David Smith Date: Mon, 2 Jun 2025 08:22:08 +0100 Subject: Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions. The `check` docs target now runs spelling, black, and lint, so all current documentation quality checks can be run with a single command. Also documented the lint-docs check's availability and usage. --- .github/workflows/docs.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to '.github/workflows') diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index df183a5c42..d648e8b5fb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -58,3 +58,19 @@ jobs: echo "💥 📢 Code blocks in documentation must be reformatted with blacken-docs 📢 💥" fi; exit $RESULT + + lint-docs: + runs-on: ubuntu-latest + name: lint-docs + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.13' + - run: python -m pip install sphinx-lint + - name: Build docs + run: | + cd docs + make lint -- cgit v1.3