Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Qiskit Transpiler Service: figure out why type hints aren't showing links #1324

Closed
Eric-Arellano opened this issue May 8, 2024 · 2 comments

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented May 8, 2024

For example:

Screenshot 2024-05-08 at 10 48 17 AM

<Function id="qiskit_transpiler_service.transpiler_service.TranspilerService.run" signature="run(circuits: List[str | QuantumCircuit] | str | QuantumCircuit)" />

Compare this with https://docs-pr-1406.preview.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch#from_id, where the type hint is in the actual source code https://github.com/Qiskit/qiskit-ibm-runtime/blob/stable/0.23/qiskit_ibm_runtime/session.py#L333-L376 yet it renders in the function body

Screenshot 2024-05-08 at 10 49 34 AM

I imagine this is an issue with the config we have. This fix should be in Sphinx, not our generation script.

@frankharkins
Copy link
Member

It seems all type hints inside signatures are not links. See https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit#assign_parameters as an example.

Screenshot 2024-05-16 at 17 51 16

The href is present in the HTML. I believe this kicks the problem back to the generation script.

@Eric-Arellano
Copy link
Collaborator Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants