linkcheck: Ignore files

[Addison Lynch]

Hello,

Is it possible to ignore certain files using the linkcheck builder? There is not an option for this in the documentation (https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder) build the option to_ignore does appear in the source code.

Happy to submit a docs PR if this is implemented but simply not documented

Thanks!

Addison Lynch

[Matthias Geier]

On Wed, Dec 16, 2020 at 9:07 AM Addison Lynch wrote:
>
> Is it possible to ignore certain files using the linkcheck builder? There is not an option for this in the documentation (https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder) build the option to_ignore does appear in the source code.

https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_ignore

> Happy to submit a docs PR if this is implemented but simply not documented

A cross reference to
https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
would probably be helpful.

cheers,
Matthias

>
> Thanks!
> Addison Lynch