Skip to content

Commit 37c44f7

Browse files
authored
Update links pointing to IQP Classic (#2264)
* Update links pointing to IQP Classic * fix long lines
1 parent ca1b7c2 commit 37c44f7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+166
-164
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ pip install -e ".[dev]"
4040

4141
### Open an issue
4242

43-
* For documentation issues relating to pages in the Start, Build, Transpile, Verify, Run, and Migration guides sections of https://docs.quantum.ibm.com, please open an issue in the [Qiskit/documentation repo](https://github.com/Qiskit/documentation/issues/new/choose) rather than the Qiskit/qiskit-ibm-runtime repo. In other words, any page that DOES NOT have `/api/` in the url should be addressed in the Qiskit/documentation repo. (Exception: the Migration guide urls contain `/api/` but are managed in the Qiskit/documentation repo.)
43+
* For documentation issues relating to pages in the Guides, Tutorials, and Migration guides sections of https://quantum.cloud.ibm.com/docs, please open an issue in the [Qiskit/documentation repo](https://github.com/Qiskit/documentation/issues/new/choose) rather than the Qiskit/qiskit-ibm-runtime repo. In other words, any page that DOES NOT have `/api/` in the url should be addressed in the Qiskit/documentation repo. (Exception: the Migration guide urls contain `/api/` but are managed in the Qiskit/documentation repo.)
4444
* For issues relating to API reference pages (any page that contains /api/ in the url), please open an issue in the repo specific to that API reference.
4545

4646
### Pull request checklist

DEPRECATION.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ The guiding principles are:
3434

3535
The public API comprises all *publicly documented* packages, modules, classes, functions, methods, and attributes.
3636

37-
An object is *publicly documented* if and only if it appears in [the hosted API documentation](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime) for `qiskit-ibm-runtime`.
37+
An object is *publicly documented* if and only if it appears in [the hosted API documentation](https://quantum.cloud.ibm.com/docs/api/qiskit-ibm-runtime) for `qiskit-ibm-runtime`.
3838
The presence of a docstring in the Python source (or a `__doc__` attribute) is not sufficient to make an object publicly documented; this documentation must also be rendered in the public API documentation.
3939

40-
As well as the objects themselves needing to be publicly documented, the only public-API *import locations* for a given object is the location it is documented at in [the public API documentation](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime), and parent modules or packages that re-export the object (if any).
41-
For example, while it is possible to import `RuntimeEncoder` from `qiskit_ibm_runtime.utils.json`, this is not a supported part of the public API because the[`RuntimeEncoder` object is documented as being in `qiskit_ibm_runtime`](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder).
40+
As well as the objects themselves needing to be publicly documented, the only public-API *import locations* for a given object is the location it is documented at in [the public API documentation](https://quantum.cloud.ibm.com/docs/api/qiskit-ibm-runtime), and parent modules or packages that re-export the object (if any).
41+
For example, while it is possible to import `RuntimeEncoder` from `qiskit_ibm_runtime.utils.json`, this is not a supported part of the public API because the[`RuntimeEncoder` object is documented as being in `qiskit_ibm_runtime`](https://quantum.cloud.ibm.com/docs/api/qiskit-ibm-runtime/runtime-encoder).
4242

4343
As a rule of thumb, if you are using `qiskit-ibm-runtime`, you should import objects from the highest-level package that exports that object.
4444

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,15 @@ All quantum applications and algorithms level are fundamentally built using thes
115115
**Primitives** are base-level functions that serve as building blocks for many quantum algorithms and applications.
116116
Primitives accept vectorized inputs, where single circuits can be grouped with array-valued specifications. That is, one circuit can be executed for arrays of n parameter sets, n observables, or both (in the case of the estimator). Each group is called a Primitive Unified Bloc (PUB), and can be represented as a tuple.
117117

118-
The [primitive interfaces](https://docs.quantum.ibm.com/api/qiskit/primitives) are defined in Qiskit.
118+
The [primitive interfaces](https://quantum.cloud.ibm.com/docs/api/qiskit/primitives) are defined in Qiskit.
119119

120120
The IBM Runtime service offers these primitives with additional features, such as built-in error suppression and mitigation.
121121

122-
There are several different options you can specify when calling the primitives. See [Primitive options](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/options) for more information.
122+
There are several different options you can specify when calling the primitives. See [Primitive options](https://quantum.cloud.ibm.com/docs/api/qiskit-ibm-runtime/options) for more information.
123123

124124
### Primitive versions
125125

126-
Version 2 of the primitives is introduced by `qiskit-ibm-runtime` release 0.21.0. Version 1 of the primitives is no longer supported. Refer to [Migrate to the V2 primitives](https://docs.quantum.ibm.com/migration-guides/v2-primitives) on how to migratie to V2 primitives. The examples below all use V2 primitives.
126+
Version 2 of the primitives is introduced by `qiskit-ibm-runtime` release 0.21.0. Version 1 of the primitives is no longer supported. Refer to [Migrate to the V2 primitives](https://quantum.cloud.ibm.com/docs/migration-guides/v2-primitives) on how to migratie to V2 primitives. The examples below all use V2 primitives.
127127

128128
### Sampler
129129

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@
131131
# Even though alabaster isn't very pretty, we use it
132132
# over the normal qiskit-ecosystem theme because it's
133133
# faster to build and these docs are only necessary
134-
# so the API docs can be integrated into docs.quantum.ibm.com.
134+
# so the API docs can be integrated into quantum.cloud.ibm.com/docs.
135135
html_theme = "alabaster"
136136
html_title = f"{project} {release}"
137137

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Qiskit Runtime |release| API Docs Preview
33
#########################################
44

5-
Qiskit Runtime docs live at docs.quantum.ibm.com and come from https://github.com/Qiskit/documentation.
5+
Qiskit Runtime docs live at http://quantum.cloud.ibm.com/docs and come from https://github.com/Qiskit/documentation.
66
This site is only used to generate our API docs, which then get migrated to
77
https://github.com/Qiskit/documentation.
88

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ ibm_dynamic_circuits = "qiskit_ibm_runtime.transpiler.plugin:IBMDynamicTranslati
9999
ibm_fractional = "qiskit_ibm_runtime.transpiler.plugin:IBMFractionalTranslationPlugin"
100100

101101
[project.urls]
102-
documentation = "https://docs.quantum.ibm.com/"
102+
documentation = "https://quantum.cloud.ibm.com/docs/"
103103
repository = "https://github.com/Qiskit/qiskit-ibm-runtime"
104104
issues = "https://github.com/Qiskit/qiskit-ibm-runtime/issues"
105105

qiskit_ibm_runtime/batch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class Batch(Session):
7979
jobs.append(job)
8080
8181
For more details, check the "`Run jobs in a batch
82-
<https://docs.quantum.ibm.com/guides/run-jobs-batch>`_" page.
82+
<https://quantum.cloud.ibm.com/docs/guides/run-jobs-batch>`_" page.
8383
"""
8484

8585
def __init__(
@@ -99,7 +99,7 @@ def __init__(
9999
forcibly closed. Can be specified as seconds (int) or a string like "2h 30m 40s".
100100
This value must be less than the
101101
`system imposed maximum
102-
<https://docs.quantum.ibm.com/guides/max-execution-time>`_.
102+
<https://quantum.cloud.ibm.com/docs/guides/max-execution-time>`_.
103103
create_new: If True, the POST session API endpoint will be called to create a new session.
104104
Prevents creating a new session when ``from_id()`` is called.
105105
Raises:

qiskit_ibm_runtime/estimator.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ def __init__(
112112
* A :class:`Batch` if you are using batch execution mode.
113113
114114
Refer to the
115-
`Qiskit Runtime documentation <https://docs.quantum.ibm.com/guides/execution-modes>`_.
115+
`Qiskit Runtime documentation
116+
<https://quantum.cloud.ibm.com/docs/guides/execution-modes>`_.
116117
for more information about the ``Execution modes``.
117118
118119
options: Estimator options, see :class:`EstimatorOptions` for detailed description.

qiskit_ibm_runtime/fake_provider/fake_backend.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ def max_circuits(self) -> int:
289289
"max_circuits is deprecated",
290290
"0.37.0",
291291
"Please see our documentation on job limits "
292-
"https://docs.quantum.ibm.com/guides/job-limits#job-limits.",
292+
"https://quantum.cloud.ibm.com/docs/guides/job-limits#job-limits.",
293293
)
294294
return self.configuration().max_experiments
295295

qiskit_ibm_runtime/ibm_backend.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ def __getattr__(self, name: str) -> Any:
215215
f"{name} is deprecated",
216216
"0.37.0",
217217
"Please see our documentation on job limits "
218-
"https://docs.quantum.ibm.com/guides/job-limits#job-limits.",
218+
"https://quantum.cloud.ibm.com/docs/guides/job-limits#job-limits.",
219219
)
220220
# Lazy load properties and pulse defaults and construct the target object.
221221
self.properties()
@@ -293,7 +293,7 @@ def max_circuits(self) -> int:
293293
"max_circuits is deprecated",
294294
"0.37.0",
295295
"Please see our documentation on job limits "
296-
"https://docs.quantum.ibm.com/guides/job-limits#job-limits.",
296+
"https://quantum.cloud.ibm.com/docs/guides/job-limits#job-limits.",
297297
)
298298
return self._max_circuits
299299

@@ -467,7 +467,7 @@ def configuration(
467467
<https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json>`_.
468468
469469
More details about backend configuration properties can be found here `QasmBackendConfiguration
470-
<https://docs.quantum.ibm.com/api/qiskit/1.4/qiskit.providers.models.QasmBackendConfiguration>`_.
470+
<https://quantum.cloud.ibm.com/docs/api/qiskit/1.4/qiskit.providers.models.QasmBackendConfiguration>`_.
471471
472472
IBM backends may also include the following properties:
473473
* ``supported_features``: a list of strings of supported features like "qasm3" for dynamic
@@ -567,7 +567,7 @@ def run(self, *args, **kwargs) -> None: # type: ignore[no-untyped-def]
567567
"""
568568
raise IBMBackendError(
569569
"Support for backend.run() has been removed. Please see our migration guide "
570-
"https://docs.quantum.ibm.com/migration-guides/qiskit-runtime for instructions "
570+
"https://quantum.cloud.ibm.com/docs/migration-guides/qiskit-runtime for instructions "
571571
"on how to migrate to the primitives interface."
572572
)
573573

0 commit comments

Comments
 (0)