Link checking with DocumenterCitations

[ArnoStrouwen]

Link checking errors when using citations from
https://github.com/ali-ramadhan/DocumenterCitations.jl

[mortenpi]

While we should probably provide some hooks in Documenter for DocumenterCitations to use, this seems more like a feature request for that package?

[odow]

Should this be transferred to https://github.com/JuliaDocs/DocumenterCitations.jl? cc @goerz

[goerz]

Yes, feel free to open an issue, if you have an example where DocumenterCitations has some unexpected behavior… but I was under the assumption that link checking already works. I'm pretty sure I've seen it warn about broken links, although there may not be an explicit test to ensure that. In any case, the way it should work is that the normal link checking in Documenter just automatically handles any URLs in the rendered bibliography. Since the pipeline step that does the checking runs after any of the pipeline steps that expand the bibliography, it shouldn't be much of a problem.

[mortenpi]

I took the liberty of transferring the issue, but maybe this should be closed instead if it's no longer an issue. Perhaps @ArnoStrouwen could confirm whether it is or not.

[odow]

Yes, since there wasn't a concrete example from OP, you should close this issue (I don't have permission). But anyone reading this who encounters a similar issue should either comment below, or open a new issue.

[goerz]

I'd consider "Add a test that checks that invalid links trigger the link checker" as the actionable item for closing this.

[goerz]

Trying to add a test uncovered that, in fact, the link checker does not traverse into the bibliography.

That's a bug, and should be fixed.

[goerz]

This will require a fix in Documenter: JuliaDocs/Documenter.jl#2329

[goerz]

As soon as JuliaDocs/Documenter.jl#2330 is merged, I'll be able to fix this