Skip to content

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

Merged
merged 3 commits into from
May 22, 2025

Conversation

arnaucasau
Copy link
Contributor

The documentation source of truth is moving to https://quantum.cloud.ibm.com/.

@woodsp-ibm
Copy link
Member

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

Wrong Copyright Year:'docs/conf.py': Current:'# (C) Copyright IBM 2021, 2024.' Correct:'# (C) Copyright IBM 2021, 2025.'

@arnaucasau
Copy link
Contributor Author

I see! I'll update all the py files. Thanks Steve!

@arnaucasau arnaucasau force-pushed the AC/intersphinx-cloud branch from 0a436bf to 8d19b8c Compare May 21, 2025 16:52
@coveralls
Copy link

coveralls commented May 21, 2025

Pull Request Test Coverage Report for Build 15187028170

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 90.821%

Totals Coverage Status
Change from base Build 15132938224: 0.0%
Covered Lines: 4492
Relevant Lines: 4946

💛 - Coveralls

woodsp-ibm
woodsp-ibm previously approved these changes May 21, 2025
Copy link
Member

@woodsp-ibm woodsp-ibm left a 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.

edoaltamura
edoaltamura previously approved these changes May 21, 2025
@edoaltamura
Copy link
Collaborator

edoaltamura commented May 22, 2025

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?
Checking this link as an example, it looks like the qiskit docs haven't been moved yet. Is there an expected move date?

@arnaucasau
Copy link
Contributor Author

arnaucasau commented May 22, 2025

Hi @edoaltamura, the link you mentioned 404s because qiskit.primitives.BaseEstimator was removed in qiskit 2.0. In that page, we link to the migration guide for more information about it.

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
new link -> https://quantum.cloud.ibm.com/docs/api/qiskit/qiskit.primitives.BaseEstimator

The new platform contains exactly the same API docs than the old one, so you could still visit the BaseEstimator page by going to the docs of any version other than the latest. This is the link for qiskit 1.4.

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?

@woodsp-ibm
Copy link
Member

I made the observation above

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.

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.

https://quantum.cloud.ibm.com/docs/en/api/qiskit/qiskit.primitives.BaseSampler
becomes
https://quantum.cloud.ibm.com/docs/en/api/qiskit/1.4/qiskit.primitives.BaseSampler

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.

@woodsp-ibm
Copy link
Member

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?

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.

@arnaucasau arnaucasau dismissed stale reviews from edoaltamura and woodsp-ibm via 8a96689 May 22, 2025 12:49
@arnaucasau
Copy link
Contributor Author

arnaucasau commented May 22, 2025

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.

Agreed! I pushed a new commit to update the broken links to point to the qiskit v1.4 API docs.

Copy link
Member

@woodsp-ibm woodsp-ibm left a 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.

@edoaltamura edoaltamura merged commit 3e7c48b into qiskit-community:main May 22, 2025
16 checks passed
@edoaltamura edoaltamura added the stable backport potential The bug might be minimal and/or import enough to be port to stable label May 22, 2025
mergify bot pushed a commit that referenced this pull request May 22, 2025
* Update intersphinx mapping and others URLs pointing to IQP Classic

* fix copyright date

* fix broken links

(cherry picked from commit 3e7c48b)
edoaltamura pushed a commit that referenced this pull request May 22, 2025
…) (#940)

* Update intersphinx mapping and others URLs pointing to IQP Classic

* fix copyright date

* fix broken links

(cherry picked from commit 3e7c48b)

Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants