ProjectPythia / pythia-foundations

Jupyterbook source for the Foundations collection
http://foundations.projectpythia.org
Apache License 2.0
59 stars 42 forks source link

Link checker CI: forbidden access #260

Closed andersy005 closed 2 years ago

andersy005 commented 2 years ago

link-checker CI has been complaining about broken external links from GitHub... the links do exist. it's just that for some reason GitHub servers appear to refuse granting access...

Screen Shot 2022-04-11 at 6 26 45 PM

i don't know how to fix this :). if someone has a clue, please chime in.

brian-rose commented 2 years ago

Weird.

Should we consider disabling the link-checker until a fix is found?

kmpaul commented 2 years ago

I'm wondering if we can make link-checker optional, and not required.

kmpaul commented 2 years ago

Or do we just ignore it for now?

kmpaul commented 2 years ago

Turns out this issue comes up with any GitHub URL in a "blank" Sphinx document. I've created an issue on the Sphinx repo to document it:

https://github.com/sphinx-doc/sphinx/issues/10343

kmpaul commented 2 years ago

Temporarily, would could ignore linkchecker on any docs.github.com links with the Sphinx option:

linkcheck_ignore = [r'https://docs.github.com']

but I don't like this option for very long!

brian-rose commented 2 years ago

I think this is the right approach. It's hard to make progress on everything else with all those nasty looking CI failures.

kmpaul commented 2 years ago

Ok. Then I'm going to push that change to @andersy005's #259 PR.

kmpaul commented 2 years ago

This is now fixed with the merge of #259. However, it is a hack, so I'm going to create a standing issue to remove the linkcheck_ignore Sphinx option when https://github.com/sphinx-doc/sphinx/issues/10343 is resolved, if ever.