Update Runtime API docs to 0.13 #222
Conversation
| ### key\_separator = ' | ||
|
|
||
| <span id="qiskit_ibm_runtime.RuntimeEncoder.key_separator" /> | ||
| `= ':` | ||
|
|
||
| `= ': '` |
There was a problem hiding this comment.
This is a regression.
Now:
Before:
qiskit.org:
There was a problem hiding this comment.
yeah this seems like a regression, but honestly the "before" layout also doesn't look great, I don't think the = should be there at all if it's on the second line
There was a problem hiding this comment.
Tracked by #224
| The [`run()`](qiskit_ibm_runtime.Estimator#run "qiskit_ibm_runtime.Estimator.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. | ||
| The [`run()`](#qiskit_ibm_runtime.Estimator.run "qiskit_ibm_runtime.Estimator.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. |
There was a problem hiding this comment.
This change is fine. The link still works. Although I'm not certain why it happened.
There was a problem hiding this comment.
are you sure this works? I just tried in prod and that syntax doesn't seem interchangeable
There was a problem hiding this comment.
Yeah, it still works because we create two IDs for the same headers:
The id is what allows the anchor to work.
This continues to be the case.
The other important detail is that the link is in the same file, which is why it's fine to have # in the beginning. Before, it was saying go to the file qiskit_ibm_runtime.Estimator, then use the anchor #run
| @@ -73,13 +70,9 @@ Initializes the Estimator primitive. | |||
|
|
|||
| ## Attributes | |||
|
|
|||
| <span id="estimator-circuits" /> | |||
There was a problem hiding this comment.
It seems fine to remove these. I'm not sure where we were getting them from before. I imagine the old Sphinx output - I don't think our script was dynamically computing the name estimator-circuits.
There was a problem hiding this comment.
is there any specific css set with this id?
There was a problem hiding this comment.
No, there shouldn't be. The reason we had these <span>s is solely for # anchors. I couldn't find anywhere using these anchors in production, so removing the link seems fine.
| <span id="qiskit_ibm_runtime.Estimator.circuits" /> | ||
|
|
||
| `tuple[qiskit.circuit.quantumcircuit.QuantumCircuit, ...]` |
There was a problem hiding this comment.
This is a good change - we were saying the return type twice for some reason.
Before:
This PR:
| `Estimator.run(circuits, observables, parameter_values=None, **kwargs)` | ||
| `run(circuits, observables, parameter_values=None, **kwargs)` |
There was a problem hiding this comment.
This change is reflected on qiskit.org, too. It's fine.
Eric-Arellano
changed the title
Now that we fixed Qiskit#67, we can regenerate the API docs. The issues were due to changes with modern Sphinx 7.2. There was one regression I noticed, but it's not enough of a show-stopper to block this PR: Qiskit#224.
Now that we fixed #67, we can regenerate the API docs. The issues were due to changes with modern Sphinx 7.2.
There was one regression I noticed, but it's not enough of a show-stopper to block this PR: #224.