Generate Provider 0.8 and 0.9 docs #784
Merged
Conversation
This file contains 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
Eric-Arellano
commented
Feb 8, 2024
|
|
||
| Backend class interfacing with an IBM Quantum device. | ||
|
|
||
| You can run experiments on a backend using the [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.45)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: | ||
| You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: |
There was a problem hiding this comment.
Note that this URL is no longer relative. I think it's because intersphinx now uses docs.quantum.ibm.com in Provider. #493 will fix this.
I don't think we should block this PR on #493. But I'll bump it in priority. Relative links are better because our link checker can check them much more quickly. The good news is that the platform at least doesn't add the arrow suggesting it's an external link; i.e. it detects it's an internal link.
kt474
approved these changes
Feb 8, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
1. Uploaded artifacts to Box and added to `api-html-artifacts.json` 2. `npm run make-historical -- -p qiskit-ibm-provider` 3. `npm run gen-api -- -p qiskit-ibm-provider -v 0.8.0 --historical` 4. `npm run gen-api -- -p qiskit-ibm-provider -v 0.9.0` This our first time having historical API docs for Provider, so it required changing our link checker to load Qiskit docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
api-html-artifacts.jsonnpm run make-historical -- -p qiskit-ibm-providernpm run gen-api -- -p qiskit-ibm-provider -v 0.8.0 --historicalnpm run gen-api -- -p qiskit-ibm-provider -v 0.9.0This our first time having historical API docs for Provider, so it required changing our link checker to load Qiskit docs.