summaryrefslogtreecommitdiff
path: root/docs/Makefile
diff options
context:
space:
mode:
authorDavid Smith <smithdc@gmail.com>2025-06-01 22:38:04 +0100
committernessita <124304+nessita@users.noreply.github.com>2025-08-25 10:51:10 -0300
commitef2f16bc4824ca2b10b7f2845baf4d313c9c0da1 (patch)
tree01fc768fdf18155e41448422fff0d7683899879e /docs/Makefile
parent0246f478882c26bc1fe293224653074cd46a90d0 (diff)
Refs #36485 -- Added sphinx-lint support and make lint rule for docs.
This adds a `lint.py` script to run sphinx-lint on Django's docs files, a mathing `lint` target in the `docs/Makefile` and `docs/make.bat`, and updates `docs/requirements.txt` accordingly.
Diffstat (limited to 'docs/Makefile')
-rw-r--r--docs/Makefile6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 9935ad09e5..78cbccd00e 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -51,6 +51,7 @@ help:
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " spelling to check for typos in documentation"
@echo " black to apply the black formatting to code blocks in documentation"
+ @echo " lint to check for linting errors in documentation"
clean:
@@ -175,6 +176,11 @@ black:
@echo
@echo "Code blocks reformatted"
+lint:
+ $(PYTHON) lint.py
+ @echo
+ @echo "Documentation lint complete."
+
check: spelling black
@echo
@echo "Style and spelling checks completed."