-
Notifications
You must be signed in to change notification settings - Fork 358
Update intersphinx mapping and other URLs pointing to IQP Classic #933
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update intersphinx mapping and other URLs pointing to IQP Classic #933
Conversation
Thanks for updating the links. We'll have to deal with the old primitive references separately that either way now end up in Page Not Exists since they do not exist in latest 2.0 version. Its failing the Checks here as for the Python .py files it does a copyright check to make sure its updated when the file itself is updated so it reflects the right years. So conf.py needs a small correction as below
|
I see! I'll update all the py files. Thanks Steve! |
0a436bf
to
8d19b8c
Compare
Pull Request Test Coverage Report for Build 15187028170Details
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for updating these links.
Thanks for updating the links! I see an update in a reno; this shouldn't lead to the same issue we recently experienced because the PR points to main - correct? |
Hi @edoaltamura, the link you mentioned 404s because You can also see that we were getting the same 404 in the old platform until now, so this PR should preserve the status quo: previous link -> https://docs.quantum.ibm.com/api/qiskit/qiskit.primitives.BaseEstimator The new platform contains exactly the same API docs than the old one, so you could still visit the I think it'd be good to update the links in this repo to avoid all the 404s, but I wasn't sure where they should point given that in the requirements, qiskit is pinned to <2.0. Should we use the 1.4 ones? Or there are plans to rewrite those docs soon when the project supports qiskit 2.0? |
I made the observation above
My thinking being that when V1 primitives are removed from main for the 2.0 support all the text/links around those V1 primitives will need to change. Now presently the the V1 classes still exist but the failing urls would need to add a specific version in them now to get to docs where they still exist e.g.
So the change is relatively small but its only needed on a subset of the changed links here. The docs are there by version so other than going to the latest by default one has to pick a specific version. As far as I know the docs are done similarly as they are from here - rewriting would mean changing all the docs bits in all code. The main difference with qiskit is that is keeps the prior versions when it publishes a new version of docs - which given where the docs are published here was not something that was done, rather just the latest exists. As to changing the urls instead of leaving them broken as they have been - it could be done in this PR since arguably main still supports the V1 primitives here - if the author is open to doing that. |
I am pretty sure we have done updates to renos in the past - so hopefully not! I merged a similar links change PR to Qiskit Algorithms yesterday and its nightly CI last night afterwards went through ok. |
Agreed! I pushed a new commit to update the broken links to point to the qiskit v1.4 API docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for updating the links.
* Update intersphinx mapping and others URLs pointing to IQP Classic * fix copyright date * fix broken links (cherry picked from commit 3e7c48b)
The documentation source of truth is moving to https://quantum.cloud.ibm.com/.