From 1d8318a271885a536c530e20d705adbdc79e526d Mon Sep 17 00:00:00 2001 From: Andrea Date: Wed, 25 Oct 2023 13:19:16 +0400 Subject: [PATCH] Add links in tutorial --- doc/source/tutorials/api.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/source/tutorials/api.rst b/doc/source/tutorials/api.rst index cb6edec83..ac750dfa9 100644 --- a/doc/source/tutorials/api.rst +++ b/doc/source/tutorials/api.rst @@ -37,12 +37,13 @@ in the following way: After defining the parameters, the user can perform the acquisition using ``experiment.acquisition`` which accepts the following parameters: -* params (experiment.parameters_type): input parameters for the experiment -* platform (qibolab.platform.Platform): Qibolab platform class -* qubits (dict[QubitId, QubitPairId]) dictionary with qubits where the acquisition will run +* params (`experiment.parameters_type `_): input parameters for the experiment +* platform (`qibolab.platform.Platform `_): Qibolab platform class +* qubits (dict[`QubitId `_, `QubitPairId `_]) dictionary with qubits where the acquisition will run and returns the following: -* data (experiment.data_type): data acquired + +* data (`experiment.data_type `_): data acquired * acquisition_time (float): acquisition time on hardware .. code-block:: python @@ -66,16 +67,16 @@ following way: To be more specific the user should pass as input ``data`` which is of type ``experiment.data_type`` and the outputs are the following: -* fit: (experiment.results_type) input parameters for the experiment +* fit: (`experiment.results_type `_) input parameters for the experiment * fit_time (float): post-processing time It is also possible to access the plots and the tables generated in the report using ``experiment.report`` which accepts the following parameters: -* data: (``experiment.data_type``) data structure used by ``experiment`` -* qubit (Union[QubitId, QubitPairId]): post-processing time -* fit: (``experiment.results_type``): data structure for post-processing used by ``experiment`` +* data: (`experiment.data_type `_) data structure used by ``experiment`` +* qubit (dict[`QubitId `_, `QubitPairId `_]): qubit / qubit pair to be plotted +* fit: (`experiment.results_type `_): data structure for post-processing used by ``experiment`` .. code-block:: python