sphinx-lint

[JulienPalard]

Description of the Change

While working on sphinx-lint I started playing with cloned repositories to search for false positives.

Happen that I had a clone of django-oauth-toolkit, so I tested on your repo, discovered and fixed one false positive on sphinx-lint, and fixed smalls nits in your doc (mixed tabs and spaces, missing newline at end of files, nothing big, congratulations for that!).

Checklist

• PR only contains one change (considered splitting up PR)
• unit-test added
• documentation updated
• CHANGELOG.md updated (only for user relevant changes)
• author name in AUTHORS

(Not added self in AUTHORS, not considering that adding a bunch of spaces can be considered as "authoring" anything :D)

[codecov]

Codecov Report

Merging #1142 (2972d01) into master (4a9039e) will not change coverage.
The diff coverage is n/a.

@@ Coverage Diff @@## master #1142 +/- ## ======================================= Coverage 96.87% 96.87% ======================================= Files 31 31 Lines 1790 1790 ======================================= Hits 1734 1734 Misses 56 56 

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4a9039e...2972d01. Read the comment docs.

[n2ygk]

Hey, thanks for this!

Could you perhaps add sphinx-lint to tox.ini, .pre-commit.yaml, etc. so we can actually keep our sphinx docs clean going forward? And please add your name to AUTHORS.

[JulienPalard]

Could you perhaps add sphinx-lint to tox.ini, .pre-commit.yaml, etc. so we can actually keep our sphinx docs clean going forward?

Done.

Beware, sphinx-lint is young, don't hesitate to ping me on https://github.com/sphinx-contrib/sphinx-lint/issues if you have any problem. We're trying hard to avoid false positives (sphinx-lint finds no false positive on cpython, sympy, pandas, ... but still finds a few in the sphinx doc (probably the harder)), and we're trying hard not to introduce regressions, but there's still a catch: you can still write some valid doc that trigger a previously unknown false positive in sphinx-lint.

And please add your name to AUTHORS.

Done.