Add CrosstalkParams to API docs and docs cleanup
#219
Conversation
| pytketdoc_base: None, | ||
| "https://qiskit.org/documentation/": None, | ||
| "http://docs.qulacs.org/en/latest/": None, | ||
| "python": ("https://docs.python.org/3/", None), |
There was a problem hiding this comment.
This updates some deprecated syntax to allow the use of sphinx > 6.2.0
| :members: | ||
| :special-members: __init__ | ||
|
|
||
| .. automodule:: pytket.extensions.qiskit.backends.crosstalk_model |
There was a problem hiding this comment.
I've added the three classes CrosstalkParams, NoisyCircuitBuilder and FractionalUnitary.
These are the only three classes which have tests so I assumed they were the only user facing classes. Is that correct?
There was a problem hiding this comment.
Update: Only CrosstalkParams is user facing
| :members: | ||
| :special-members: __init__ | ||
|
|
||
| .. automodule:: pytket.extensions.qiskit.backends.crosstalk_model | ||
| :members: CrosstalkParams, NoisyCircuitBuilder, FractionalUnitary | ||
|
|
There was a problem hiding this comment.
Is there a simplier import path for these classes? They do look a bit squashed in the API docs.
| @@ -74,28 +75,20 @@ class CrosstalkParams: | |||
| Stores various parameters for modelling crosstalk noise | |||
|
|
|||
There was a problem hiding this comment.
These types will be automatically inferred by the sphinx-autodoc-typehints extension. We won't have to write them down in multiple places.
| :param non_markovian_noise: List storing the non-Markovian noise parameters. | ||
| Each tuple in the list contains the qubit index and the zx, zz noise parameters. | ||
| :type non_markovian_noise: `List[Tuple[Qubit, float, float]]` | ||
| :param virtual_z: If True, then don't break any single qubit Z gate into |
There was a problem hiding this comment.
The sphinx_autodoc_typehints extension allows these types to be inferred from the source code so we no longer need to put these types in two different places.
CalMacCQ
changed the title
CalMacCQ
changed the title
CalMacCQ
changed the title
CrosstalParams to API docs and docs cleanup
CalMacCQ
changed the title
CrosstalParams to API docs and docs cleanupCrosstalkParams to API docs and docs cleanup
Closes #210
CrossTalkParams,FractionalUnitaryandNoisyCircuitBuilderclasses to the API documentation.(Update: Only
CrosstalkParamsis user facing)conf.pyto allow sphinx > 6.2.0IBMQBackend.process_circuit.