Skip to content

Missing API references for Runtime #238

@Eric-Arellano

Description

@Eric-Arellano

There are a few APIs that aren't actually documented at qiskit.org/documentation and docs.quantum-computing.ibm.com. The code exists, but it isn't in the API docs because we don't put the code member in its owning module's __init__.py file so Sphinx doesn't generate a page for the entity.

To fix this, you have to change the underlying API docs. For adding new modules, we need to add a file to https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/docs/apidocs and also update ibm-runtime.rst with it.

To change what shows up in a module, you have to change the __init__.py like how this is set https://github.com/Qiskit/qiskit-ibm-runtime/blob/8723ccf827fd7b43bf653d76e9c254ad00f9be4b/qiskit_ibm_runtime/__init__.py#L13-L161

Then cherry-pick to the stable branch and rebuild the docs with it. Finally, regenerate our docs. (I/Eric can help with these parts.)

Tracked by Qiskit/qiskit#11290 and Qiskit/qiskit-ibm-runtime#1236

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions