summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDavid Smith <smithdc@gmail.com>2025-06-02 08:22:08 +0100
committernessita <124304+nessita@users.noreply.github.com>2025-08-25 10:51:10 -0300
commit43e4d0a1422d87cc804097f7eb127b6ffa07e840 (patch)
tree7a559d75c990963a272c8546022ee4d84924f968 /.github
parentf81e6e3a53ee36e3f730a71aa55a5744982dd016 (diff)
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.
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/docs.yml16
1 files changed, 16 insertions, 0 deletions
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