diff --git a/docs/_ext/custom_styles/styles.py b/docs/_ext/custom_styles/styles.py index 9127ff4fc9..adbc5f9b55 100644 --- a/docs/_ext/custom_styles/styles.py +++ b/docs/_ext/custom_styles/styles.py @@ -212,8 +212,8 @@ def _extra_sections(self, sectioned_docstring: Dict[str, List[str]]): # add transpiler option transpiler_option_desc = [ "This option is used for circuit optimization. ", - "See `Qiskit Transpiler `_ documentation for available options.", + "See the documentation of :func:`qiskit.transpile ` " + "for available options.", "", ] transpiler_option_desc.extend( @@ -230,8 +230,9 @@ def _extra_sections(self, sectioned_docstring: Dict[str, List[str]]): "This option is used for controlling job execution condition. " "Note that this option is provider dependent. " "See provider's backend runner API for available options. " - "See `here `_ for IBM Quantum Service.", + "See the documentation of " + ":meth:`IBMQBackend.run ` " + "for the IBM Quantum Service.", "", ] run_option_desc.extend( diff --git a/docs/conf.py b/docs/conf.py index fe2987e984..21663b8e7c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -182,8 +182,14 @@ "style_external_links": True, } -autoclass_content = "both" -intersphinx_mapping = {"matplotlib": ("https://matplotlib.org/stable/", None)} + +autoclass_content = 'both' +intersphinx_mapping = { + 'matplotlib': ('https://matplotlib.org/stable/', None), + 'qiskit': ('https://qiskit.org/documentation/', None), +} + + # Current scipy hosted docs are missing the object.inv file so leaving this # commented out until the missing file is added back. # 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None)} diff --git a/qiskit_experiments/database_service/__init__.py b/qiskit_experiments/database_service/__init__.py index 4ee59e18b0..4049c7d748 100644 --- a/qiskit_experiments/database_service/__init__.py +++ b/qiskit_experiments/database_service/__init__.py @@ -61,8 +61,8 @@ class only for convenience. example, to retrieve a saved analysis result. Currently only IBM Quantum provides this database service. See -`qiskit-ibmq-provider `_ -for more details. +the :mod:`Experiment ` module in the IBM +Quantum provider for more details. Classes ======= diff --git a/qiskit_experiments/library/quantum_volume/qv_experiment.py b/qiskit_experiments/library/quantum_volume/qv_experiment.py index 06a5b00713..353e004afc 100644 --- a/qiskit_experiments/library/quantum_volume/qv_experiment.py +++ b/qiskit_experiments/library/quantum_volume/qv_experiment.py @@ -49,12 +49,11 @@ class QuantumVolume(BaseExperiment): `_ for an explanation on the QV protocol. - In the QV experiment we generate `QV circuits - `_ - on :math:`d` qubits, which contain :math:`d` layers, where each layer consists of random 2-qubit + In the QV experiment we generate :class:`~qiskit.circuit.library.QuantumVolume` circuits on + :math:`d` qubits, which contain :math:`d` layers, where each layer consists of random 2-qubit unitary gates from :math:`SU(4)`, followed by a random permutation on the :math:`d` qubits. - Then these circuits run on the quantum backend and on an ideal simulator - (either :class:`AerSimulator` or :class:`qiskit.quantum_info.Statevector`). + Then these circuits run on the quantum backend and on an ideal simulator (either + :class:`~qiskit.providers.aer.AerSimulator` or :class:`~qiskit.quantum_info.Statevector`). A depth :math:`d` QV circuit is successful if it has 'mean heavy-output probability' > 2/3 with confidence level > 0.977 (corresponding to z_value = 2), and at least 100 trials have been ran.