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

Add doc testing to Python client repositories #1893

Closed
Tracked by #1892
Eric-Arellano opened this issue Aug 30, 2024 · 1 comment · Fixed by Qiskit/qiskit#13179
Closed
Tracked by #1892

Add doc testing to Python client repositories #1893

Eric-Arellano opened this issue Aug 30, 2024 · 1 comment · Fixed by Qiskit/qiskit#13179

Comments

@Eric-Arellano
Copy link
Collaborator

It's important that the API docs code blocks do not break with code changes. We have too many docs to manually check that there are not issues, so we should automate it.

For Qiskit SDK, they don't want to run doctests in every PR because it's too slow. So they should have a weekly (nightly?) cron job, and also be able to manually trigger it.

qiskit-ibm-runtime and qiskit-ibm-transpiler might be fast enough to run every PR.

@frankharkins
Copy link
Member

Update: PR has been made to Qiskit SDK. Qiskit Runtime already uses Jupyter execute, and Qiskit IBM Transpiler does not currently have any code examples.

@javabster javabster moved this from In Review to In Progress in Docs Planning Oct 21, 2024
@Eric-Arellano Eric-Arellano moved this from In Progress to In Review in Docs Planning Nov 4, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in Docs Planning Dec 2, 2024
@javabster javabster removed this from Docs Planning Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants