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.
This commit is contained in:
David Smith
2025-06-02 08:22:08 +01:00
committed by nessita
parent f81e6e3a53
commit 43e4d0a142
7 changed files with 64 additions and 8 deletions

View File

@@ -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