CI: Lint docs

[szepeviktor]

There is a tool called sphinx-lint

[szepeviktor]

reStructuredText converts TAB characters to spaces :(
https://cs.symfony.com/doc/rules/whitespace/indentation_type.html 👀

[szepeviktor]

I see! Documentation is generated from FixerDefinition.
For example definition for method_argument_space deliberately contains trailing spaces.
💡

[Wirone]

Yeah, this one may be tricky, since docs are generated (with composer docs script), and there are tests that verify consistency between source code and generated RSTs. But it looks promising, it's great to spot such things like in this PR's diff 👌.

[szepeviktor]

@Wirone Please help me code these two.

doc/ruleSets/PER-CS1.0.rst:5: default role used (hint: for inline literals, use double backticks) (default-role)
doc/ruleSets/PER-CS1.0Risky.rst:5: default role used (hint: for inline literals, use double backticks) (default-role)

In rst world we need two backticks.

PHP-CS-Fixer/src/RuleSet/Sets/PERCS1x0RiskySet.php

Line 46 in 9901473

**This ruleset is deprecated** in favour of `@PER-CS2.0:risky`.

[Wirone]

@szepeviktor I am AFK right now, reviewing from mobile. Now I am going to be mostly offline, I can look in the evening if the problem remains 🙂.

[Wirone]

@szepeviktor I've changed those 2 sets locally (double backtick), generated docs (composer docs) and whole QA suite (composer qa) is green. I've reproduced Sphinxlint's CI job locally (inside of docker run --rm -it -w /fixer -v pwd:/fixer ubuntu:22.04 bash) and it looks OK:

root@996bbd4a9326:/fixer# apt-get update && apt-get install python3 pip git && pip install --user sphinx-lint && mv /root/.local/bin/sphinx-lint /usr/local/bin/

root@996bbd4a9326:/fixer# git --version
git version 2.34.1
root@996bbd4a9326:/fixer# sphinx-lint --version
sphinx-lint 0.9.0
root@996bbd4a9326:/fixer# git ls-files --cached -z -- '*.rst' | xargs --null -- python3 -m sphinxlint --enable all --disable trailing-whitespace --max-line-length 2000
No problems found.

I'll just push the changes here (with a rebase).

[coveralls]

coverage: 94.918% (-0.004%) from 94.922%
when pulling 85367e4 on szepeviktor:rst
into 39596a3 on PHP-CS-Fixer:master.

[Wirone]

Great stuff @szepeviktor 👏 . LGTM.