Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
38 stars 81 forks source link

Improve link checker ignores of objects.inv for non-API docs #2296

Closed Eric-Arellano closed 3 days ago

Eric-Arellano commented 1 week ago

We ignore all of these because the docs have non-API docs in their Sphinx build, like tutorials, so the objects.inv has a ton of invalid links.

https://github.com/Qiskit/documentation/blob/6999dcabd9eb3144238aac8ed6fc731ec134bc65/scripts/js/lib/links/ignores.ts#L17-L27

However, it would be better to still check objects.inv and not ignore the API links. We should automatically do that rather than making you specify the non-API links in objects.inv.