Docs link check

[lochhh]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
This PR

• checks for broken/redirected links in the documentation using the Sphinx linkcheck builder.
• centralises websites commonly referenced in the documentation to ease the management of external links.

What does this PR do?
This PR

• updates redirected URLs to the redirect locations (as indicated by the Sphinx linkcheck builder).
• creates aliases to base URLs of websites referenced more than once by collecting these under myst_url_schemes in conf.py.

References

This PR addresses #75.

How has this PR been tested?

The docs have been built locally.

Does this PR require an update to the documentation?

We may want to add linkcheck as an option in the docs: building the docs locally and/or include this step in the GitHub build docs workflow.

Checklist:

• The code has been tested locally
• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (45955d3) 98.05% compared to head (eee216f) 98.05%.

❗ Current head eee216f differs from pull request most recent head f890628. Consider uploading reports for the commit f890628 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #80   +/-   ##
=======================================
  Coverage   98.05%   98.05%           
=======================================
  Files           8        8           
  Lines         308      308           
=======================================
  Hits          302      302           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[niksirbi]

This is fantastic @lochhh! Will save us so much tume and headspace.

I have two comments:

1. Should we document this in the CONTRIBUTING guide? Perhaps mention in the Editind the documetation section that external urls should be added to conf.py

2. I found out I can run sphinx-build -b linkcheck docs/source docs/build locally to include link checking during the build. I have to add this to the relevant GitHub action, right?

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[niksirbi]

This all seems to work fine now. Should we merge?

[lochhh]

This all seems to work fine now. Should we merge?

yep. Thanks for the review! I'll rebase #79 once this is merged.