update provider and aer ref links

qiskit-community · Feb 7, 2024 · 5544899 · 5544899
1 parent 6641efa
commit 5544899
Show file tree

Hide file tree

Showing 24 changed files with 37 additions and 35 deletions.
diff --git a/docs/howtos/cloud_service.rst b/docs/howtos/cloud_service.rst
@@ -18,8 +18,8 @@ Saving
 ~~~~~~
 
 .. note::
-    This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
-    For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`,
+    This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
+    For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
     consult the `migration guide <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.\
 
 You must run the experiment on a real IBM

diff --git a/docs/howtos/rerun_analysis.rst b/docs/howtos/rerun_analysis.rst
@@ -12,8 +12,8 @@ Solution
 --------
 
 .. note::
-    This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
-    For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`,
+    This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
+    For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
     consult the `migration guide <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.\
 
 Once you recreate the exact experiment you ran and all of its parameters and options,

diff --git a/docs/howtos/runtime_sessions.rst b/docs/howtos/runtime_sessions.rst
@@ -11,11 +11,11 @@ Solution
 --------
 
 .. note::
-    This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
-    For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`,
+    This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
+    For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
     consult the `migration guide <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.\
 
-Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :mod:`qiskit_ibm_runtime`, which supports sessions.
+Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :external+qiskit_ibm_runtime:doc:`index`, which supports sessions.
 
 In this example, we will set the ``max_circuits`` property to an artificially low value so that the experiment will be
 split into multiple jobs that run sequentially in a single session. When running real experiments with a

diff --git a/docs/manuals/characterization/stark_experiment.rst b/docs/manuals/characterization/stark_experiment.rst
@@ -113,7 +113,7 @@ In a typical IBM device using the cross-resonance drive architecture,
 such channel can be identified with your backend as follows:
 
 .. note::
-    This tutorial requires the :mod:`qiskit_ibm_runtime` package to model a
+    This tutorial requires the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` package to model a
     backend.  You can install it with ``python -m pip install qiskit-ibm-runtime``.
 
 .. jupyter-execute::

diff --git a/docs/manuals/characterization/t1.rst b/docs/manuals/characterization/t1.rst
@@ -30,7 +30,7 @@ The following code demonstrates a basic run of a :math:`T_1` experiment
 for qubit 0.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/manuals/characterization/t2ramsey.rst b/docs/manuals/characterization/t2ramsey.rst
@@ -58,7 +58,7 @@ We run the experiment on a simulated backend using Qiskit Aer with a
 pure T1/T2 relaxation noise model.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/manuals/characterization/tphi.rst b/docs/manuals/characterization/tphi.rst
@@ -21,7 +21,7 @@ From the :math:`T_1` and :math:`T_2` estimates, we compute the results for
 :math:`T_\varphi.`
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/manuals/measurement/readout_mitigation.rst b/docs/manuals/measurement/readout_mitigation.rst
@@ -31,7 +31,7 @@ This notebook demonstrates the usage of both the local and correlated
 experiments to generate the corresponding mitigators.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/manuals/measurement/restless_measurements.rst b/docs/manuals/measurement/restless_measurements.rst
@@ -59,7 +59,7 @@ observe any meaningful outcomes with fake backends since the circuit simulator
 they use always starts with the qubits in the ground state.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_ibm_runtime` package to model a
+    This tutorial requires the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` package to model a
     backend.  You can install it with ``python -m pip install qiskit-ibm-runtime``.
 
 .. jupyter-execute::

diff --git a/docs/manuals/verification/quantum_volume.rst b/docs/manuals/verification/quantum_volume.rst
@@ -25,7 +25,7 @@ probability` > 2/3 with confidence level > 0.977 (corresponding to
 z_value = 2), and at least 100 trials have been ran.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/manuals/verification/randomized_benchmarking.rst b/docs/manuals/verification/randomized_benchmarking.rst
@@ -12,7 +12,7 @@ error estimates for the quantum device, by calculating the Error Per Clifford. S
 explanation on the RB method, which is based on Refs. [1]_ [2]_.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/manuals/verification/state_tomography.rst b/docs/manuals/verification/state_tomography.rst
@@ -8,7 +8,7 @@ of a quantum state by preparing the state many times and measuring them in a tom
 complete basis of measurement operators.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 

diff --git a/docs/tutorials/custom_experiment.rst b/docs/tutorials/custom_experiment.rst
@@ -558,7 +558,7 @@ output if the Pauli corresponding to that bit has a nonzero signature.
 To test our code, we first simulate a noisy backend with asymmetric readout error.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` package for simulations.
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` package for simulations.
     You can install it with ``python -m pip install qiskit-aer``.
 
 

diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst
@@ -58,7 +58,7 @@ Experiments must be run on a backend. We're going to use a simulator,
 backend, real or simulated, that you can access through Qiskit.
 
 .. note::
-    This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime`
+    This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer <index>` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`
     packages to run simulations.  You can install them with ``python -m pip
     install qiskit-aer qiskit-ibm-runtime``.
 
@@ -184,7 +184,7 @@ value and standard deviation of each value can be accessed as follows:
     print(exp_data.analysis_results("T1").value.std_dev)
 
 For further documentation on how to work with UFloats, consult the ``uncertainties``
-:external+uncertainties:doc:`user_guide`.
+:external+uncertainties:doc:`index`. :external+qiskit_ibm_runtime:doc:`index`
 
 Raw circuit output data and its associated metadata can be accessed with the
 :meth:`~.ExperimentData.data` property. Data is indexed by the circuit it corresponds

diff --git a/docs/tutorials/visualization.rst b/docs/tutorials/visualization.rst
@@ -34,8 +34,8 @@ Generating and customizing a figure using a plotter
 First, we display the default figure from a :class:`.Rabi` experiment as a starting point:
 
 .. note::
-    This tutorial requires the :mod:`qiskit_dynamics`, :mod:`qiskit_aer`, and
-    :mod:`qiskit_ibm_runtime` packages to run simulations.  You can install them
+    This tutorial requires the :mod:`qiskit_dynamics`, :external+qiskit_aer:doc:`qiskit-aer <index>`, and
+    :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` packages to run simulations.  You can install them
     with ``python -m pip install qiskit-dynamics qiskit-aer qiskit-ibm-runtime``.
 
 .. jupyter-execute::

diff --git a/qiskit_experiments/framework/experiment_data.py b/qiskit_experiments/framework/experiment_data.py
@@ -2255,7 +2255,8 @@ def load(
             experiment_id: Experiment ID.
             service: the database service.
             provider: an IBMProvider required for loading job data and
-                can be used to initialize the service. When using :mod:`qiskit_ibm_runtime`,
+                can be used to initialize the service. When using
+                :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
                 this is the :class:`~qiskit_ibm_runtime.QiskitRuntimeService` and should
                 not be confused with the experiment database service
                 :meth:`qiskit_ibm_experiment.IBMExperimentService`.

diff --git a/qiskit_experiments/library/calibration/half_angle_cal.py b/qiskit_experiments/library/calibration/half_angle_cal.py
@@ -28,7 +28,7 @@
 
 
 class HalfAngleCal(BaseCalibrationExperiment, HalfAngle):
-    """Calibration version of the half-angle experiment."""
+    """Calibration version of the :class:`.HalfAngle` experiment."""
 
     def __init__(
         self,

diff --git a/qiskit_experiments/library/quantum_volume/qv_experiment.py b/qiskit_experiments/library/quantum_volume/qv_experiment.py
@@ -88,7 +88,7 @@ def __init__(
             simulation_backend: The simulator backend to use to generate
                 the expected results. the simulator must have a 'save_probabilities'
                 method. If None, the :class:`qiskit_aer.AerSimulator` simulator will be used
-                (in case :mod:`qiskit_aer` is not
+                (in case :external+qiskit_aer:doc:`qiskit-aer <index>` is not
                 installed, :class:`qiskit.quantum_info.Statevector` will be used).
         """
         super().__init__(physical_qubits, analysis=QuantumVolumeAnalysis(), backend=backend)

diff --git a/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml b/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml
@@ -6,7 +6,7 @@ prelude: >
     benchmarking experiments has been significantly improved. The ``qubit`` and
     ``qubits`` input to experiments has been regularized to ``physical_qubits``,
     and support for ``qiskit-ibmq-provider`` has been deprecated in favor of
-    :mod:`qiskit_ibm_provider`. New experiments added include
+    :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>`. New experiments added include
     :class:`.MultiStateDiscrimination`, :class:`.ZZRamsey`,
     :class:`.MitigatedStateTomography`, and
     :class:`.MitigatedProcessTomography`, along with significant improvements to

diff --git a/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml b/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml
@@ -4,7 +4,7 @@ fixes:
     Updated querying of :class:`~qiskit.providers.Backend` metadata to support
     the look up of qubit T1 and measurement drive frequency, in order to
     support :class:`~qiskit.providers.BackendV2` backends. The look up of the
-    latter is :mod:`qiskit_ibm_provider` specific. This change fixed errors
+    latter is :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` specific. This change fixed errors
     failing to find these properties when using :class:`.ResonatorSpectroscopy`
     (issue `#1099 <https://github.com/Qiskit-Extensions/qiskit-experiments/issues/1099>`_)
     and when using restless measurements with ``BackendV2`` backends.
diff --git a/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml b/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml
@@ -2,7 +2,7 @@
 upgrade:
   - |
     ``qiskit-ibmq-provider`` is deprecated and has been dropped as a requirement. Interactions
-    with IBM backends should use the :mod:`qiskit_ibm_provider` package instead (must be installed
+    with IBM backends should use the :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` package instead (must be installed
     separately; see the 
     `migration guide <https://qiskit.org/ecosystem/ibm-provider/tutorials/Migration_Guide_from_qiskit-ibmq-provider.html>`_
     for more details).
diff --git a/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml b/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml
@@ -4,7 +4,7 @@ fixes:
     Fixed qpy serialization and deserialization of tomography experiments. The
     barrier instructions in tomography experiments were created with the wrong
     Python type which qpy did not support. This issue was most acute when using
-    :mod:`qiskit_ibm_provider` which submits circuits to the provider using qpy.
+    :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` which submits circuits to the provider using qpy.
     There could have been subtler issues with circuit timing using a different
     provider if the barriers were not separating important circuit
     instructions. See `#1060 <https://github.com/Qiskit-Extensions/qiskit-experiments/issues/1060>`_.
diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml
@@ -9,7 +9,8 @@ prelude: >
     results. New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and
     :class:`.StarkRamseyXYAmpScan`. :class:`.StandardRB` and :class:`.InterleavedRB` were
     significantly improved. The supported provider for running jobs on IBM backends is now
-    :mod:`qiskit_ibm_runtime`. Using :mod:`qiskit_ibm_provider` is still supported but its use is
-    deprecated.
+    :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`. Using 
+    :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` is still supported
+    but its use is deprecated.
 features:
     New features are listed below in subsections by functional area.
diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml
@@ -1,14 +1,14 @@
 ---
 features_expdata:
   - |
-    Experiments run via the :mod:`qiskit_ibm_runtime` provider can now be saved
+    Experiments run via the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` provider can now be saved
     to and loaded from the cloud service.
 upgrade:
   - |
-    With the impending deprecation of the :mod:`qiskit_ibm_provider` package, support for
-    :mod:`qiskit_ibm_provider` is now deprecated and will be removed
-    in the next release. Users should migrate to :mod:`qiskit_ibm_runtime` following the
+    With the impending deprecation of the :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` package, support for
+    :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` is now deprecated and will be removed
+    in the next release. Users should migrate to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` following the
     `runtime migration guide
     <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.
-    :mod:`qiskit_ibm_runtime` is not listed as a dependency for compatibility reasons, but users
+    :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` is not listed as a dependency for compatibility reasons, but users
     will need it to run experiments on IBM backends.