Add a link checker to the CI

[qartik]

There is often link rot that happens over time, it might be nice to add an automated link checker such as https://github.com/UmbrellaDocs/linkspector or https://github.com/stevenvachon/broken-link-checker (blc) to the CI to prevent this problem.

Here are links that I identified using blc that are currently broken:

Getting links from: https://docs.quantinuum.com/nexus/trainings/getting_started.html
├─BROKEN─ https://docs.quantinuum.com/nexus/nexus_api/qnexus_api.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/manual/howto.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/manual/express.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/intro.html
├─BROKEN─ https://docs.quantinuum.com/lambeq/tutorials/sentence-input.ipynb (HTTP_404)

Getting links from: https://docs.quantinuum.com/h-series/trainings/getting_started/qnexus/Quantinuum_hseries_resource_visibility.html
├─BROKEN─ https://nexus.quantinuuum.com/ (ERRNO_ENOTFOUND)
├─BROKEN─ https://docs.quantinuum.com/nexus/concepts/access_control.html (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.qiskit_to_tk
├─BROKEN─ https://tket.quantinuum.com/user-manual/manual_backend.html#embedding-into-qiskit (HTTP_404)
├─BROKEN─ https://github.com/CQCL/pytket/blob/main/examples/qiskit_integration.ipynb (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/introduction/overview.html
├─BROKEN─ https://cqcl.github.io/pytket-extensions/api/index.html (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/introduction/installation.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/introduction/system_requirements.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/introduction/troubleshooting.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/introduction/installation.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/introduction/quickstart.html
├─BROKEN─ https://cqcl.github.io/pytket-extensions/api/index.html#statevector-simulators (HTTP_404)
├─BROKEN─ https://cqcl.github.io/pytket-extensions/api/index.html (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/inquanto/manual/ansatzae_overview.rst (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/inquanto/manual/minimizers.rst (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/inquanto/manual/computables_overview.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/manual/protocols/resource_estimation.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/manual/protocols/phase_est.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/tutorials/InQ_tut_vqe_1.html
├─BROKEN─ https://cqcl.github.io/pytket/manual/manual_circuit.html#analysing-circuits (HTTP_404)
├─BROKEN─ https://cqcl.github.io/pytket-extensions/api/index.html (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/tutorials/quantinuum_hardware.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/tutorials/hardware_tutorial.html (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/tutorials/InQ_tut_fe4n2_3.html
├─BROKEN─ https://cqcl.github.io/pytket/manual/manual_circuit.html#analysing-circuits (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/inquanto/introduction/quantinuum_hardware.html (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/extensions/extensions-overview.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/extensions/inquanto-pyscf.rst (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/inquanto/extensions/inquanto-nglview.rst (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/inquanto/extensions/inquanto-phayes.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/api/inquanto/computables.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/api/inquanto/%3Chttps:/arxiv.org/abs/1603.05681%3E%60 (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/misc/changelog.html
├─BROKEN─ https://docs.quantinuum.com/inquanto/manual/express.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/inquanto/misc/bibliography.html
├─BROKEN─ https://arxiv.org/abs/https:/doi.org/10.1063/1.1499208 (HTTP_404)
├─BROKEN─ https://arxiv.org/abs/https:/pubs.aip.org/aip/jcp/article-pdf/118/21/9481/19024657/9481/_1/_online.pdf (HTTP_404)
├─BROKEN─ https://arxiv.org/abs/https:/pubs.aip.org/aip/jcp/article-pdf/doi/10.1063/1.4820484/15465582/134105/_1/_online.pdf (HTTP_404)
├─BROKEN─ https://doi.org/https:/doi.org/10.1103/PhysRevA.99.032331 (HTTP_400)

Getting links from: https://docs.quantinuum.com/inquanto/misc/opensource.html
├─BROKEN─ http://uncertainties-python-package.readthedocs.io/ (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/pipeline.html
├─BROKEN─ https://docs.quantinuum.com/lambeq/tutorials/rewrite.ipynb (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/lambeq/tutorials/parameterise.ipynb (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/use-cases.html
├─BROKEN─ https://quantumai.google/quantum-computing-service (HTTP_404)
├─BROKEN─ https://www.quandela.co/ (ERRNO_ECONNRESET)

Getting links from: https://docs.quantinuum.com/lambeq/training.html
├─BROKEN─ https://docs.quantinuum.com/lambeq/manual-training.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/CONTRIBUTING.html
├─BROKEN─ https://docs.quantinuum.com/lambeq/advanced.rst (HTTP_404)
├─BROKEN─ https://docs.quantinuum.com/lambeq/tutorials/extend-lambeq.ipynb (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/models.html
├─BROKEN─ https://docs.quantinuum.com/lambeq/tutorials/trainer-classical.ipynb (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/manual-training.html
├─BROKEN─ https://docs.quantinuum.com/lambeq/training.rst (HTTP_404)

Getting links from: https://docs.quantinuum.com/lambeq/bibliography.html
├─BROKEN─ https://arxiv.org/abs/https:/academic.oup.com/comjnl/article-pdf/7/4/308/1013182/7-4-308.pdf (HTTP_404)
├─BROKEN─ https://doi.org/10.1162/COLI/_a/_00263 (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-pyquil
└─BROKEN─ http://rigetti.com/forest (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-cutensornet
└─BROKEN─ https://docs.nvidia.com/cuda/cuquantum/latest/python/README.html#installation (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-qulacs
├─BROKEN─ https://docs.nvidia.com/cuda/cuda-installation-guide-mac-os-x/ (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/examples
├─BROKEN─ https://docs.quantinuum.com/tket/examples/docs.quantinuum.com/tket/user-guide/ (HTTP_404)
└─BROKEN─ https://docs.quantinuum.com/tket/examples/docs.quantinuum.com/tket/user-guide/ (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-pyquil/index.html
├─BROKEN─ http://rigetti.com/forest (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-qulacs/index.html
├─BROKEN─ https://docs.nvidia.com/cuda/cuda-installation-guide-mac-os-x/ (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/blog/posts/september_release_pytket/
├─BROKEN─ https://cqcl.github.io/pytket/manual/manual_circuit.html#boxes-for-unitary-synthesis (HTTP_404)
├─BROKEN─ https://cqcl.github.io/pytket/manual/manual_assertion.html (HTTP_404)
└─BROKEN─ https://cqcl.github.io/pytket-extensions/api/index.html (HTTP_404)

Getting links from: https://docs.quantinuum.com/tket/extensions/pytket-cutensornet/index.html
├─BROKEN─ https://docs.nvidia.com/cuda/cuquantum/latest/python/README.html#installation (HTTP_404)

[irfankhan10]

Thanks Qartik, sorry for the slow follow up here. I will share with the TKET team