#36485 closed Cleanup/optimization (fixed)
Add linting tool for documentation
Reported by: | David Smith | Owned by: | David Smith |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Adam Johnson | Triage Stage: | Ready for checkin |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
As Natalia wrote on this 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 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.
Change History (15)
comment:2 by , 3 months ago
Has patch: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
Version: | 5.2 → dev |
Thank you David! I'm so looking forward to this :-)
comment:5 by , 6 weeks ago
Cc: | added |
---|
comment:6 by , 4 weeks ago
Triage Stage: | Accepted → Ready for checkin |
---|
[PR https://github.com/django/django/pull/19549]