id	summary	reporter	owner	description	type	status	component	version	severity	resolution	keywords	cc	stage	has_patch	needs_docs	needs_tests	needs_better_patch	easy	ui_ux
36485	Add linting tool for documentation	David Smith	David Smith	"As Natalia wrote on this [https://forum.djangoproject.com/t/automatic-docs-linter-for-style-consistency/41383 forum post]

> Currently, style guidelines for docs are well documented, but checking them is still a manual part of the review process. That often results in extra back-and-forth over small formatting details, which can slow things down. Automating this would help ease that overhead, making reviews more efficient for both contributors and maintainers.

The documentation can be linted with [https://github.com/sphinx-contrib/sphinx-lint?rgh-link-date=2025-06-09T22%3A42%3A19Z sphinx-lint] with some modifications such that it works with Django's documentation. Main edits are for Django's `.txt` extension (vs default `.rst`) and some additional exceptions for the line length check. "	Cleanup/optimization	closed	Documentation	dev	Normal	fixed		Adam Johnson	Ready for checkin	1	0	0	0	0	0