Adjust T1 doc strings to automatic template

[yaelbh]

Summary

Addressing #254, mimicking #255.

Details and comments

Currently failing (at least locally, for me, let's see how the CI reacts) with:

reading sources... [ 69%] stubs/qiskit_experiments.library.characterization.ResonanceAnalysis                                                                                                                                                 
Exception occurred:
  File "/home/hrlquantum/work/experiments/NaokiDoc/docs/_ext/custom_styles/styles.py", line 251, in _extra_sections
    defaults=self._target_cls._default_transpile_options().__dict__,
AttributeError: type object 'ResonanceAnalysis' has no attribute '_default_transpile_options'

Please fix it (probably @eggerdj), then I guess that this PR will be ready to go.

[yaelbh]

Yes, CI agrees with my local run

[nkanazawa1989]

Thanks @yaelbh . If you add template, this will be applied to all module under the autosummary. If you want to apply this partly, you can do something like
https://github.com/Qiskit/qiskit-experiments/blob/36fe3134e4f1ae9e3e2b5654d7169905ac191365/qiskit_experiments/library/__init__.py#L23-L35

Please let me know if you find any difficulty.

[nkanazawa1989]

Suggested change

	defpar amplitude:
	defpar a:

This is written as a in the fit model. If you want to write some word here, you may want to add \rm, i.e. \rm amplitude, since this value will be shown in the math mode and become Itaric.

[nkanazawa1989]

Oh I found why it caused an error. This is a wrong template.
https://github.com/Qiskit/qiskit-experiments/blob/36fe3134e4f1ae9e3e2b5654d7169905ac191365/qiskit_experiments/library/randomized_benchmarking/__init__.py#L35

[yaelbh]

@nkanazawa1989 Thanks for the review, I fixed according to your comments 😄

[yaelbh]

1. I have the same issue like Merav, of seeing #section.
2. Why does it say that there are no experiment and analysis options, and how to fix it?

[nkanazawa1989]

Thanks @yaelbh. To write options, you need to provide documentation for analysis options and experiment options in self.__AnalysisClass__._default_options and self._default_experiment_options. Here you can find an example

https://github.com/Qiskit/qiskit-experiments/blob/30814c947e51b43cfac93738d0385314ba450cd5/docs/_ext/custom_styles/example/example_experiment.py#L105-L108

https://github.com/Qiskit/qiskit-experiments/blob/30814c947e51b43cfac93738d0385314ba450cd5/docs/_ext/custom_styles/example/example_experiment.py#L192-L195

These options are automatically parsed (if some options are already defined in the superclass the Sphinx extension will check superclass and port documentation from there, so you don't need to write documentation multiple times) and shown in the class documentation. This will be propagated to set_*_options method in future extension.

Calibration module has already completed so you can also check this :)

[nkanazawa1989]

You need to list descriptions introduced in this subclass here. i.e.

Suggested change

	"""Default analysis options"""
	"""Default analysis options
	Analysis Options:
	t1_guess (Type): Doc
	amplitude_guess (Type): Doc
	offset_guess (Type): Doc
	"""

[nkanazawa1989]

FYI
https://github.com/Qiskit/qiskit-experiments/blob/main/qiskit_experiments/library/calibration/drag.py
https://github.com/Qiskit/qiskit-experiments/blob/main/qiskit_experiments/library/calibration/analysis/drag_analysis.py

[yaelbh]

Current status:

1. I still see "#section".
2. In the T1 page there's "reference to analysis class: T1Analysis" without a link to the doc of this class.

[nkanazawa1989]

LGTM thanks @yaelbh