Use pa11y-ci instead of pa11y

[tarek-y-ismail]

Main improvement: improved readability of logs, as well as "potential" performance improvements due to not having to launch pa11y for each file. In addition, pa11y-ci offers a concurrency option, but that seems to be broken at the moment.

pa11y output:

Welcome to Pa11y

 > Running Pa11y on URL file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/404/index.html

No issues found!


Welcome to Pa11y

 > Running Pa11y on URL file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/search/index.html

No issues found!


Welcome to Pa11y

 > Running Pa11y on URL file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/tutorial/index.html

Results for URL: file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/tutorial/index.html

 • Error: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.31:1. Recommendation:  change text colour to #f9fcff.
   ├── WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
   ├── #installing-mir-on-debian > p > a
   └── <a class="reference external" href="https://tracker.debian.org/pkg/...">https://tracker.debian.org/pkg/mir</a>

pa11y-ci output:

Running Pa11y on 26 URLs:
 > file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/404/index.html - 0 errors
 > file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/search/index.html - 0 errors
 > file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/tutorial/index.html - 0 errors
 > file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/genindex/index.html - 0 errors
 > file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/reference/continuous-integration/index.html - 0 errors
 > file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/reference/kernel_requirements/index.html - 0 errors

...

Errors in file:///home/tarek/code-projects/mir/doc/build_doc/doc/sphinx/_build/reference/introducing_the_miral_api/index.html:

 • This element has insufficient contrast at this conformance level. Expected a
   contrast ratio of at least 4.5:1, but text in this element has a contrast
   ratio of 3.84:1. Recommendation:  change text colour to #bb5400.

   (#codecell0 > span:nth-child(82))

   <span class="o">::</span>

 • This element has insufficient contrast at this conformance level. Expected a
   contrast ratio of at least 4.5:1, but text in this element has a contrast
   ratio of 3.84:1. Recommendation:  change text colour to #bb5400.

   (#codecell0 > span:nth-child(101))

   <span class="o">=</span>

[evilnick]

Thanks. This is a great improvement as the current output isn't fit for purpose IMO

[evilnick]

The only thing I am unclear about is if we need to redefine the targets for this. Can't we just run pa11y-ci on line 108 instead?
The reason being, other tools and processes expect that target to exist

[tarek-y-ismail]

The only thing I am unclear about is if we need to redefine the targets for this. Can't we just run pa11y-ci on line 108 instead? The reason being, other tools and processes expect that target to exist

A very reasonable request. Does the latest commit address this? I'm not too deep in the Make ecosystem so I might've missed something :)

[SecondSkoll]

The .PHONY targets have changed but not the actual Make commands. Otherwise this all seems fine.

[SecondSkoll]

Suggested change

	sp-pa11y-install:
	sp-pa11y-ci-install:

[SecondSkoll]

Suggested change

	sp-pa11y: sp-pa11y-ci-install sp-html
	sp-pa11y-ci: sp-pa11y-ci-install sp-html

[tarek-y-ismail]

I think the better approach would be to revert the phony naming changes instead. I don't know why I forgot them but thanks for pointing that out :)

[SecondSkoll]

Done and done, thanks @tarek-y-ismail