fix: Skip ReadTheDocs verions during Sphinx link check

[matthewfeickert]

Description

Resolves #2029

• Add 'https://pyhf.readthedocs.io/en/.*' to the linkcheck ignore as tags for a release won't exist until it is made, but ReadTheDocs needs to reference them.
• Remove linkcheck from ReadTheDocs config.

Checklist Before Requesting Reviewer

• Tests are passing
• "WIP" removed from the title of the pull request
• Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

• Summarize commit messages into a comprehensive review of the PR

* Add 'https://pyhf.readthedocs.io/en/.*' to the linkcheck ignore as tags
 for a release won't exist until it is made, but ReadTheDocs needs to reference them.
* Remove linkcheck from ReadTheDocs config.

[matthewfeickert]

This is needed as

pyhf/.readthedocs.yaml

Lines 17 to 19 in 931dd36

	jobs:
	pre_build:
	- python -m sphinx -b linkcheck docs/ _build/linkcheck

caught https://pyhf.readthedocs.io/en/v0.7.0/ during the release build, which didn't exist yet, and failed. 😬

Not sure if there is a way to save the https://pyhf.readthedocs.io/en/v0.7.0/ URL or if that is gone forever.

[matthewfeickert]

https://pyhf--2031.org.readthedocs.build/en/2031/ works. So is there some way we can get that build up under https://pyhf.readthedocs.io/en/v0.7.0/?

[matthewfeickert]

This docs build is going to fail for the expected reason of

faq: line   13) broken    https://pyhf.readthedocs.io/ - 404 Client Error: Not Found for url: https://pyhf.readthedocs.io/en/v0.7.0/

and that's okay.

[codecov]

Codecov Report

Base: 98.30% // Head: 98.30% // No change to project coverage 👍

Coverage data is based on head (7a01ad1) compared to base (931dd36).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2031   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4530     4530           
  Branches      738      738           
=======================================
  Hits         4453     4453           
  Misses         45       45           
  Partials       32       32           

Flag	Coverage Δ
contrib	27.52% <ø> (ø)
doctest	61.14% <ø> (ø)
unittests-3.10	96.31% <ø> (ø)
unittests-3.7	96.28% <ø> (ø)
unittests-3.8	96.33% <ø> (ø)
unittests-3.9	96.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[matthewfeickert]

I just need https://pyhf.readthedocs.io/en/v0.7.0/ to point to https://pyhf.readthedocs.io/en/stable/ so that v0.7.0 can get built. How to do this?

[matthewfeickert]

Fixed after this PR by:

• Changing the redirect of https://pyhf.readthedocs.io/ to https://pyhf.readthedocs.io/en/latest/ in the RTD backend options.
• Then triggering a build on RTD for the failing v0.7.0 build.
• The build then passes the link check and succeeds to build the rest of the docs and deploys to https://pyhf.readthedocs.io/en/v0.7.0/.
• Change the redirect of https://pyhf.readthedocs.io/ back to the latest tag.

Don't break your docs!