Autodoc migration for RB #255
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
July 29, 2021 01:32
yaelbh
reviewed
Jul 29, 2021
qiskit_experiments/library/randomized_benchmarking/interleaved_rb_analysis.py
Outdated
Show resolved
Hide resolved
qiskit_experiments/library/randomized_benchmarking/interleaved_rb_analysis.py
Show resolved
Hide resolved
| the interleaved gate error. See Ref. [1] for details. | ||
| See :class:`InterleavedRBAnalysis` documentation for additional | ||
| information on interleaved RB experiment analysis. |
Collaborator
There was a problem hiding this comment.
Do we really want to remove this sentence? Maybe it can be helpful.
Collaborator
Author
There was a problem hiding this comment.
Do we need this? Because another dedicated section for analysis class reference is generated and other experiment class doesn't write this.
| `arXiv:quant-ph/1203.4550 <https://arxiv.org/pdf/1203.4550>`_ | ||
| Analysis Class | ||
| :class:`InterleavedRBAnalysis` |
Collaborator
There was a problem hiding this comment.
Maybe it's good to refer to the corresponding analysis class
Collaborator
Author
There was a problem hiding this comment.
It's automatically generated.
| - **lengths**: A list of RB sequences lengths. | ||
| - **num_samples**: Number of samples to generate for each sequence length. | ||
| - **interleaved_element**: The element to interleave, | ||
| given either as a group element or as an instruction/circuit |
Collaborator
There was a problem hiding this comment.
Why was this section removed?
Collaborator
Author
There was a problem hiding this comment.
It's automatically generated.
Collaborator
Author
|
Thanks @yaelbh for the comments. I reverted some changes. |
5 tasks
coruscating
approved these changes
Aug 3, 2021
paco-ri
pushed a commit
to paco-ri/qiskit-experiments
that referenced
this pull request
Jul 11, 2022
* autodoc migration * remove change * revert changes Co-authored-by: Helena Zhang <Helena.Zhang@ibm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is an example of how to migrate to autodoc syntax.
What you need to do is
:template:underautosummarydirective# section: overviewAnalysisClass._default_optionsmethod **ExperimentClass._default_experiment_optionsmethod **defparsyntax for fit parameter description** Use Google style docstring. Documentation of arguments in the superclass is automatically extracted so you only need to write documentation for newly introduced argument in the class.
Tips for math
To write math equations, you need to avoid writing something like
**n,e**(a+b),a*b,3*xetc... Note that in the math directive you need to use standard latex syntax.Details and comments
See example documentation for available syntax.
https://github.com/Qiskit/qiskit-experiments/blob/a8b0210f5a6eed2d13e5129e15e766b6a0e7fd2f/docs/_ext/custom_styles/example/example_experiment.py#L120-L170
Local build
For the first time
I added one package to the
requirements-devso you may need-roption to recreate the environment This will take some itme. If you have already renewed the environment after #116,-ris not necessary.