Add explanation of %%writefile magic for notebook readers#4794
Closed
frankharkins wants to merge 48 commits intoajc/serverless-feedbackfrom
Closed
Add explanation of %%writefile magic for notebook readers#4794frankharkins wants to merge 48 commits intoajc/serverless-feedbackfrom
%%writefile magic for notebook readers#4794frankharkins wants to merge 48 commits intoajc/serverless-feedbackfrom
Conversation
We removed this to speed up CI time in #4271, but CI broke recently and this seems to fix it (thanks @arnaucasau for the solution). Not sure why this used to take three minutes, but it only adds a few extra seconds now.
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
Add preview link for main branch.
Closes #4700. --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Closes #4696. Add carriage return both after <Admonition> and before </Admonition> so that the right spacing renders in the published page.
This PR tweaks our script to ensure we can generate the qiskit-ibm-runtime docs correctly after Qiskit/qiskit-ibm-runtime#2623. It also adds a new TOC order for runtime. This PR builds the new artifact on top of the current dev docs in 1c4b453 to have an example for the review
This reverts the stale PR preview cleanup. This feature removed previews for open PRs that have been inactive for over two weeks. We decided to remove it for the following reasons: 1. We originally introduced this to improve the reliability and speed of preview deployments. However, we're not sure it makes a noticeable difference; there are usually only one or two stale previews at any one point in time (vs ~20-30 previews in total). 2. Even with the small number of stale previews, the expiration has inconvenienced writers who needed to share previews with stakeholders. 3. The final straw is that the tests are broken in a really nasty way: They fail on the GitHub actions MacOS runner but pass on our local MacOS machines. When I deleted the failing test to debug things, the Windows runner started showing even more crazy errors. I have no idea what's causing it but it's related to the `datetime` library and I think it's going to take a lot of time to fix. I also think there's a real risk the code is actually broken and it's not just a test problem. With points 1 & 2, we decided to just remove the feature.
CC: @fpietra @HuangJunye --------- Signed-off-by: Roberto Di Remigio Eikås <robertodr@users.noreply.github.com> Co-authored-by: Roberto Di Remigio Eikås <robertodr@users.noreply.github.com> Co-authored-by: davidemateria <davide.materia@algorithmiq.fi> Co-authored-by: Francesca <francesca@algorithmiq.fi> Co-authored-by: Junye Huang <h.jun.ye@gmail.com> Co-authored-by: Francesca Pietracaprina <fpietra@users.noreply.github.com> Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Closes #4687. --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
It adds two new TOC entries that I found by generating the latest docs from Qiskit/qiskit-ibm-runtime#2623
We're switching to use the Carbon's `Accordion` component. This PR updates markdown-generating code that uses `details`. I've split this into separate commits to make review easier: * 72a1080 requires the closest review: This updates the logic that writes the generated markdown * c790c38 used find-and-replace to switch the "package versions" in each notebook to accordions. I executed a notebook to make sure this was equivalent to the generated markdown * 2a60194 is the result of `npm run regen-apis -- -p qiskit`, but I reset all the image changes to avoid noise. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
#4180) Co-authored-by: abbycross <across@us.ibm.com>
@assafb Do these look like the right changes to be made to docs/tutorial? FYI @pandasa123
Closes #4537 I looked around and confirmed that we don't fail to mention that Herons support fractional gates anywhere else in the docs, just in this one page.
I've gotten feedback stating that the composer is a helpful "getting started" tool and I would like us to prioritize its placement for better visibility to new users. This PR moves the `IBM Quantum Composer` documentation to the getting started section.
An action recently executed the notebooks in this repo. This PR updates all notebooks that ran successfully with the new cell outputs. > [!NOTE] > This pull request was created by a GitHub action. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
This PR updates the preview image digest. The new version exposes the `THead` and `TBody` components to ensure tables have the correct styling when explicitly used inside other components
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This PR removes a period that shouldn't be part of the math expression. This was affecting our translations.
Second part of #4748
This PR switches some `<details>` tags to the new `<Accordion>` component. I haven't switched all the tags; some will require rewording to make the titles fit on one line. I only switched tags that didn't require any rewording. --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: abbycross <across@us.ibm.com>
When testing the new Qiskit sphinx docs artifact in #4605 I noticed that Sphinx 9.1.0 started using `span` instead of `em` for the properties. For the proof-of-concept PR I work around it by doing [this](d14acd6), but I think this PRs approach is much cleaner. We should merge this before Qiskit updates their Sphinx version to avoid having bad docs in the next "Update dev docs" PR. I tested this changes against the same artifact from #4605 to validate everything was working and I also ran `npm run regen-apis` to ensure we are not adding any regression.
See #4749 for more context. This is a pass through the Guides directory; still need to do Learning and Tutorials. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
``` npm run gen-api -- -p qiskit-addon-utils -v 0.3.1 ```
…n) (#4313) CC: @jyu00 Consolidate two files containing similar/overlapping content: [Get backend information with Qiskit](https://quantum.cloud.ibm.com/docs/en/guides/get-qpu-information) and [QPU information](https://quantum.cloud.ibm.com/docs/en/guides/qpu-information). @Eric-Arellano @frankharkins @arnaucasau FYI: when it is time to merge, can you please set up a redirect from `qpu-information.mdx` to `get-qpu-information.ipynb`? Closes #4249 --------- Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Fixes the version selector and tables inside accordions
part of #4716 --------- Co-authored-by: Kaelyn Ferris <43348706+kaelynj@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This PR reorders the TOC of every API to have a first section with the API index and the release notes. Moreover, it adds a divider to help differentiate between metadata about the API versus the API itself. The only manual commit is c761bb9. The rest were generated by `npm run regen-apis`
Removes new pills that were added > 3 weeks ago
The version selector requires some manual intervention to move releases from "Stable" to "Deprecated" after a new major version has been released for over six months. This PR adds an action that will check PyPI to see if the version should be deprecated and makes a new issue if one does not already exist. See #4778 for an example issue --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Closes #4430 --------- Co-authored-by: abbycross <across@us.ibm.com>
Adding new course content for review. Still reformatting 2 figures and the references in one lesson. But text review can begin. Many thanks. --------- Co-authored-by: abbycross <across@us.ibm.com>
Corrects minor issue regarding executive summary for new course
We decided the team does not have the capacity for now to actively solicit community translations. We know that the machine translations often, unfortunately, have issues. We are somewhat constrained by how we can do those translations for now. So, given community feedback, we've taken alternative approaches to encourage English, like defaulting to English unless the user explicitly opts into a translation.
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
I spotted these on the website
Docs generated by: ``` npm run gen-api -- -p qiskit-ibm-transpiler -v 0.17.0 --historical npm run gen-api -- -p qiskit-ibm-transpiler -v 0.18.0 ```
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Merged
Collaborator
|
Adding this directly into #4715 to avoid merge conflicts, so closing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.