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.

Sign up for GitHub

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

Jump to bottom

Add dev version of the API docs #316

Closed
Eric-Arellano opened this issue Nov 9, 2023 · 3 comments
Closed

Add dev version of the API docs #316

Eric-Arellano opened this issue Nov 9, 2023 · 3 comments
Assignees
@arnaucasau
Labels
infra 🏗️
Milestone
24-02-15 Qiskit 1.0

Comments

@Eric-Arellano
Copy link
Collaborator

This has been really useful for qiskit.org/documentation since we added it ~2 months ago. We should include a dev version of the docs. Maybe set up a cron job for that to update the docs every night, 3 days, or week.
@Eric-Arellano Eric-Arellano added this to the 24-01-30 Qiskit 1.0 milestone Nov 9, 2023
@Eric-Arellano Eric-Arellano mentioned this issue Dec 6, 2023
Closed
@Eric-Arellano
Copy link
Collaborator Author

To do this, we need a way to automatically get the artifact URL for the latest commit. That relates to #501.

I'm going to remove this from the Qiskit 1.0 milestone. It would still be great to have, but there are even bigger priorities like #479, #454, and #476.

@Eric-Arellano Eric-Arellano removed this from the 24-02-13 Qiskit 1.0 milestone Dec 13, 2023
This was referenced Feb 1, 2024
Closed
Closed
@Eric-Arellano
Copy link
Collaborator Author

We decided to start with adding a /dev version of the docs that is manually generated for now. #745 tracks switching it to CD.

We need to make these changes:

  1. updateApiDocs.ts will add a /dev folder and takes the --dev arg.
    • check that our support code, like link checker, works on --dev
  2. teach the docs app how to handle /dev
    • don't use it in search index
    • the version dropdown should add the label (dev) and add it to the top

@Eric-Arellano Eric-Arellano added this to the 24-02-13 Qiskit 1.0 milestone Feb 5, 2024
This was referenced Feb 6, 2024
Closed
Merged
github-merge-queue bot pushed a commit that referenced this issue Feb 7, 2024
@arnaucasau
Refactor of Pkg to add a package type (#775)
4e81fa7 
Part of #316 

This PR replaces the `historical` attribute of the class `Pkg` for an
attribute named `type` which will allow us to know if the package
version is the latest one or the historical one. This small refactor is
convenient to avoid having a bunch of boolean attributes when the
version types `dev` and `stable` are introduced.

Different version types will have different behaviors in our API
generation script like a custom path (e.g. numerical subfolder or `dev`
subfolder).
@arnaucasau arnaucasau mentioned this issue Feb 7, 2024
Merged
@Eric-Arellano Eric-Arellano moved this to In Progress in Docs Planning Feb 7, 2024
github-merge-queue bot pushed a commit that referenced this issue Feb 8, 2024
@arnaucasau @Eric-Arellano
Extend the API generation script to generate dev versions (#779)
36e6f14 
This PR adds support to generate dev versions for the API generation
script.

For the moment, the automatic regeneration will not take into account
dev versions to keep this PR easy to review. I'll add support for that
in a follow-up, together with the documentation of the dev versions.

Part of #316

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
This was referenced Feb 8, 2024
Merged
Merged
Merged
github-merge-queue bot pushed a commit that referenced this issue Feb 9, 2024
@arnaucasau
API generation script uses correct artifact names (#786)
13ba5e6 
Part of #316 

This PR adds the artifacts for the dev versions of qiskit and
qiskit-ibm-runtime and fixes how we read the JSON file to take into
account the new names of the artifacts.
github-merge-queue bot pushed a commit that referenced this issue Feb 9, 2024
@arnaucasau
Generate qiskit and qiskit-ibm-runtime dev versions (#787)
4a9f837 
Part of #316 

This PR generates the `dev` versions of qiskit 1.0.0 and
qiskit-ibm-runtime 0.19.2

Commands used:
```bash
npm run gen-api -- -p qiskit -v 1.0.0-dev --dev
npm run gen-api -- -p qiskit-ibm-runtime -v 0.19.2-dev --dev
```
To be able to generate the versions, you need to apply the changes from
#786
github-merge-queue bot pushed a commit that referenced this issue Feb 9, 2024
@arnaucasau
Extend the regen-apis command to regenerate dev versions (#788)
92c8599 
Part of #316 

This PR extends the API automatic regeneration script to regenerate dev
versions. When using the `npm run regen-apis` command, the script will
read the `_package.json` from the `dev` folder if it exists and
regenerate that version as the last one of the package.
@Eric-Arellano Eric-Arellano moved this from In Progress to In Review in Docs Planning Feb 9, 2024
@Eric-Arellano
Copy link
Collaborator Author

Great job @arnaucasau! https://docs.quantum.ibm.com/api/qiskit/dev 🎉

@github-project-automation github-project-automation bot moved this from In Review to Done in Docs Planning Feb 12, 2024
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@arnaucasau
Refactor of Pkg to add a package type (Qiskit#775)
bb4b416 
Part of Qiskit#316 

This PR replaces the `historical` attribute of the class `Pkg` for an
attribute named `type` which will allow us to know if the package
version is the latest one or the historical one. This small refactor is
convenient to avoid having a bunch of boolean attributes when the
version types `dev` and `stable` are introduced.

Different version types will have different behaviors in our API
generation script like a custom path (e.g. numerical subfolder or `dev`
subfolder).
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@arnaucasau @Eric-Arellano
Extend the API generation script to generate dev versions (Qiskit#779)
dbf724a 
This PR adds support to generate dev versions for the API generation
script.

For the moment, the automatic regeneration will not take into account
dev versions to keep this PR easy to review. I'll add support for that
in a follow-up, together with the documentation of the dev versions.

Part of Qiskit#316

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@arnaucasau
API generation script uses correct artifact names (Qiskit#786)
c291fea 
Part of Qiskit#316 

This PR adds the artifacts for the dev versions of qiskit and
qiskit-ibm-runtime and fixes how we read the JSON file to take into
account the new names of the artifacts.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@arnaucasau
Generate qiskit and qiskit-ibm-runtime dev versions (Qiskit#787)
9676f5d 
Part of Qiskit#316 

This PR generates the `dev` versions of qiskit 1.0.0 and
qiskit-ibm-runtime 0.19.2

Commands used:
```bash
npm run gen-api -- -p qiskit -v 1.0.0-dev --dev
npm run gen-api -- -p qiskit-ibm-runtime -v 0.19.2-dev --dev
```
To be able to generate the versions, you need to apply the changes from
Qiskit#786
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@arnaucasau
Extend the regen-apis command to regenerate dev versions (Qiskit#788)
287c3fe 
Part of Qiskit#316 

This PR extends the API automatic regeneration script to regenerate dev
versions. When using the `npm run regen-apis` command, the script will
read the `_package.json` from the `dev` folder if it exists and
regenerate that version as the last one of the package.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arnaucasau arnaucasau

Labels
infra 🏗️
Projects
Docs Planning
Archived in project
Milestone
24-02-15 Qiskit 1.0
Development

No branches or pull requests
2 participants
@Eric-Arellano @arnaucasau