Qiskit / Qiskit/documentation

Better automate API docs generation process

Open
#4,879 0 comments 0 reactions 1 assignee View on GitHub

@kaelynj is already working on this.

Since Sep 14, 2026.

API docs epic 🏔️ infra 🏗️
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

It's quite tedious to generate new API docs.

The main limitation we've faced in the past is not having a Box API to automate uploading the zip file. We should revalidate if there is still not an API.

Even if there is not an API we can use for Box, we could automate all of the other steps documented in the README, such as downloading the file from GitHub Releases. We could have the script pause at the point that where the user needs to manually intervene.

There needs to be some thought into the API design for npm run gen-api. It is very helpful to keep having the script behave how it currently is, i.e. not mess around with GH actions or write Git commits by default. The current surface area makes it less risky to run the script because it has fewer side-effects, and it allows it to be composed nicely with things like the regen-apis script. Instead, we should either add a new script or add new CLI args, such as: npm run gen-api -- -p qiskit -v 2.4.0 --update-box --save-historical --bump-dev

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.