#36485: Add linting tool for documentation
-------------------------------------+-------------------------------------
Reporter: David | Owner: David Smith
Smith |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 5.2
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/36485>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/01070197bb96b735-09e0888d-90c9-4d9e-a4a0-c2ea088f2ad3-000000%40eu-central-1.amazonses.com.
