Publish linkcheck failures at end of test

[Daltz333]

With a project with thousands of links, it can be a hassle searching through console or CI for the broken links and line numbers. It'd be great and convenient if Sphinx published the line numbers and broken link at the end of the linkcheck.

[tk0miya]

What do you mean "publish"?

[Daltz333]

Just text at the bottom of the build log

[mgeier]

@Daltz333 Note that the linkcheck builder creates an output.txt file which doesn't contain the successful checks (IIRC).

It does, however, include the re-directions, so it might still be hard to spot the broken links.

Also, there is a output.json file which you can process with a script if you want.

[tk0miya]

I think "line numbers" have already been displayed. I guess you'd like to know the name of document additionally, right?

$ make linkcheck
...
writing output... [100%] sub

(line    4) ok        https://www.google.co.jp/
(line    2) broken    https://www.example.com/path/ - 404 Client Error: Not Found for url: https://www.example.com/path/
build finished with problems, 1 warning.

[tk0miya]

Or, do you want to show the list of broken URLs instead of the whole of results?

[Daltz333]

Yep, the list of broken URLs instead of the whole result would work.

My original issue was hoping that immediately above "build finished with problems, 1 warning" would show the broken url right near it, so I don't have to scroll thousands of lines.

[tk0miya]

Okay, I understand your request. +1; Reasonable.

[AA-Turner]

cc: @jayaddison

I ran into this myself recently, I think a summary (a la pytest) with all broken links repeated would be useful.

A