Test API generation with a Sphinx 9.1.0 artifact#4605
Draft
arnaucasau wants to merge 5 commits intomainfrom
Draft
Test API generation with a Sphinx 9.1.0 artifact#4605arnaucasau wants to merge 5 commits intomainfrom
arnaucasau wants to merge 5 commits intomainfrom
Conversation
arnaucasau
commented
Jan 29, 2026
| ### run | ||
|
|
||
| <Function id="qiskit.primitives.BaseEstimatorV2.run" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/primitives/base/base_estimator.py#L78-L93" signature="run(pubs, *, precision=None)" modifiers="abstract"> | ||
| <Function id="qiskit.primitives.BaseEstimatorV2.run" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/primitives/base/base_estimator.py#L78-L93" signature="run(pubs, *, precision=None)" modifiers="abstractmethod"> |
Collaborator
Author
There was a problem hiding this comment.
New abstractmethod modifier
| ##### new | ||
|
|
||
| <Function id="qiskit.circuit.classical.expr.Var.new" signature="new(ty)"> | ||
| <Function id="qiskit.circuit.classical.expr.Var.new" signature="new(name, ty)" modifiers="classmethod"> |
Collaborator
Author
There was a problem hiding this comment.
New classmethod modifier
| #### ExperimentalFeatures | ||
|
|
||
| <Class id="qiskit.qasm3.ExperimentalFeatures" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/qasm3/experimental.py#L21-L70" signature="qiskit.qasm3.ExperimentalFeatures(value)" modifiers="class"> | ||
| <Class id="qiskit.qasm3.ExperimentalFeatures" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/qasm3/experimental.py#L21-L70" signature="qiskit.qasm3.ExperimentalFeatures(*values)" modifiers="class"> |
Collaborator
Author
There was a problem hiding this comment.
The signature arguments are now positional lists in some cases
| ### name | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GRZ.name" attributeTypeHint="str"> | ||
| <Attribute id="qiskit.circuit.library.GRZ.name"> |
Collaborator
Author
There was a problem hiding this comment.
The type hint was missing from the HTML compared to other artifacts. Specifically this part:
<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a>
arnaucasau
commented
Feb 1, 2026
| ### sort\_key | ||
|
|
||
| <Attribute id="qiskit.dagcircuit.DAGDepNode.sort_key" attributeTypeHint="str" /> | ||
| <Attribute id="qiskit.dagcircuit.DAGDepNode.sort_key" /> |
Collaborator
Author
There was a problem hiding this comment.
It seems like we recovered every type hint, but we now lost the ones from this file
Member
There was a problem hiding this comment.
Yeah, seems like the type annotations in DAGDepNode are only inline in the __init__ method, which makes them opaque to Sphinx. I'll move them into class-level annotations to make it work again.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Builds off #4603
This PR is a test to verify that the API generation script can generate the docs from Sphinx v9 artifacts. See Qiskit/qiskit#15615
The generation can be found in 0742f01