1537759 - lint restructured text files

Status: RESOLVED DUPLICATE of bug 1527361

(Developer Infrastructure :: Lint and Formatting, enhancement)

Description

[Tarek Ziadé (:tarek)]

I've noticed on bug 1535562 a small reStructuredText error.

Those are hard to detect when underlying titles, we should add a rst linter

To build a linter for reST files, we can use rst2html output and error code, which will detect the issue and give us a human readable error we can add prior to landing the patch

Comment 1

[Tarek Ziadé (:tarek)]

We can use the command I added in Python for inspiration:

https://hg.python.org/cpython/file/tip/Lib/distutils/command/check.py

Comment 2

[Sylvestre Ledru [:Sylvestre]]

Do you know any linter doing that?
Another option might be to add --halt=2 (warning) to rst2html (default: 4 - severe)

Comment 3

[Andrew Halberstadt [:ahal]]

I'm going to dupe this to the other one as I've linked that other one out to a few places (was hoping to make it part of a GSoC project, though if anyone wants it finished sooner, feel free to grab it).

I'm also open to linters other than restructuredtext-lint.

Comment 4

[Andrew Halberstadt [:ahal]]

Worth noting that fixing bug 1536103 would probably also have caught the problem.