From 3179529afe36d3f3501a0aa323fe6c0adce58bd2 Mon Sep 17 00:00:00 2001 From: abbycross Date: Thu, 16 Jul 2026 15:37:51 -0400 Subject: [PATCH 1/3] Update README.md Add details about extra step for generating an addon's latest API docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3359189fc2ce..f1418ddb5c9a 100644 --- a/README.md +++ b/README.md @@ -415,7 +415,7 @@ All release types start with the following steps: 3. Click the CI run name. (Not the middle column with the blue link!) 4. In the left navbar, it should show as selected the "Summary" page with the house. 5. Scroll down to "Artifacts" and look for the artifact related to documentation, such as `html_docs`. - 6. Download the artifact by clicking on its name. + 6. Download the artifact by clicking on its name. **Note:** For qiskit-addon-utils (and possibly others?) the downloaded zip file contains an extra parent directory, meaning that the step to copy over the docs for the newest version will only delete files, and not add or change existing ones. To fix this, uncompress the zip file and open the top-most directory, so that you are viewing a collection of files and folders such as `_downloads`, `_images`, `objects.inv`, and others. Select all these files and folders and compress into a new zip file, which you will now rename (see step 5 below) and upload (step 6). 4. On some operating systems, the downloaded zip file will be auto-expanded rather than staying a zip file. If this happens, compress it back to a zip file. On macOS, secondary-click on the folder in Finder and use the "Compress" option. 5. Rename the downloaded zip file with its minor-version number. For example, for the release `0.45.2`, rename `html_docs.zip` to `0.45.zip`. For release candidates (rc), use a value like `2.3-rc.zip`. From 545222990c90c4c1affa5cbe1c6b05f8ad1de87a Mon Sep 17 00:00:00 2001 From: abbycross Date: Tue, 28 Jul 2026 17:26:19 -0400 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Kaelyn Ferris <43348706+kaelynj@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f1418ddb5c9a..0ff018338675 100644 --- a/README.md +++ b/README.md @@ -415,7 +415,7 @@ All release types start with the following steps: 3. Click the CI run name. (Not the middle column with the blue link!) 4. In the left navbar, it should show as selected the "Summary" page with the house. 5. Scroll down to "Artifacts" and look for the artifact related to documentation, such as `html_docs`. - 6. Download the artifact by clicking on its name. **Note:** For qiskit-addon-utils (and possibly others?) the downloaded zip file contains an extra parent directory, meaning that the step to copy over the docs for the newest version will only delete files, and not add or change existing ones. To fix this, uncompress the zip file and open the top-most directory, so that you are viewing a collection of files and folders such as `_downloads`, `_images`, `objects.inv`, and others. Select all these files and folders and compress into a new zip file, which you will now rename (see step 5 below) and upload (step 6). + 6. Download the artifact by clicking on its name. **Note:** For `qiskit-addon-utils` (and possibly others) the downloaded zip file might contain an extra parent directory. This will cause the `gen-addon` script to run incorrectly and leave your changes in a broken state. To fix this, uncompress the zip file and open the top-most directory, so that you are viewing a collection of files and folders such as `_downloads`, `_images`, `objects.inv`, and others. Select all these files and folders and compress into a new zip file, which you will now rename (see step 5 below) and upload (step 6). 4. On some operating systems, the downloaded zip file will be auto-expanded rather than staying a zip file. If this happens, compress it back to a zip file. On macOS, secondary-click on the folder in Finder and use the "Compress" option. 5. Rename the downloaded zip file with its minor-version number. For example, for the release `0.45.2`, rename `html_docs.zip` to `0.45.zip`. For release candidates (rc), use a value like `2.3-rc.zip`. From 1da1926c107c779743d1c2f5bb50f1d135903990 Mon Sep 17 00:00:00 2001 From: abbycross Date: Wed, 29 Jul 2026 09:54:46 -0400 Subject: [PATCH 3/3] Update README.md Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ff018338675..4f9d8b1fc0fd 100644 --- a/README.md +++ b/README.md @@ -415,7 +415,7 @@ All release types start with the following steps: 3. Click the CI run name. (Not the middle column with the blue link!) 4. In the left navbar, it should show as selected the "Summary" page with the house. 5. Scroll down to "Artifacts" and look for the artifact related to documentation, such as `html_docs`. - 6. Download the artifact by clicking on its name. **Note:** For `qiskit-addon-utils` (and possibly others) the downloaded zip file might contain an extra parent directory. This will cause the `gen-addon` script to run incorrectly and leave your changes in a broken state. To fix this, uncompress the zip file and open the top-most directory, so that you are viewing a collection of files and folders such as `_downloads`, `_images`, `objects.inv`, and others. Select all these files and folders and compress into a new zip file, which you will now rename (see step 5 below) and upload (step 6). + 6. Download the artifact by clicking on its name. **Note:** For `qiskit-addon-utils` (and possibly others) the downloaded zip file might contain an extra parent directory. This will cause the `gen-addon` script to run incorrectly and leave your changes in a broken state. To fix this, uncompress the zip file and open the top-level directory, so you are viewing a collection of files and folders such as `_downloads`, `_images`, `objects.inv`, and others. Select all these files and folders and compress into a new zip file, which you will rename (see step 5 below) and upload (step 6). 4. On some operating systems, the downloaded zip file will be auto-expanded rather than staying a zip file. If this happens, compress it back to a zip file. On macOS, secondary-click on the folder in Finder and use the "Compress" option. 5. Rename the downloaded zip file with its minor-version number. For example, for the release `0.45.2`, rename `html_docs.zip` to `0.45.zip`. For release candidates (rc), use a value like `2.3-rc.zip`.