mirror of
https://github.com/django/django.git
synced 2026-02-09 02:49:25 +08:00
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:
16
.github/workflows/docs.yml
vendored
16
.github/workflows/docs.yml
vendored
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user