docs: Update new QPU compiler backend documentation #1708
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
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
Shadow53
approved these changes
Dec 7, 2023
Co-authored-by: Michael Bryant <[email protected]>
kalzoo
approved these changes
Dec 7, 2023
docs/source/introducing_v4.rst
Outdated
|
|
||
| api_options = QPUCompilerAPIOptions() | ||
| api_options.use_backend_v2() | ||
| api_options.v2( | ||
| # See API docs for QPUCompilerAPIOptions for more information on this and other parameters |
There was a problem hiding this comment.
Two problems:
-
There isn't a great way to link inside of the code block as far as I can tell, but this isn't such a big deal because it is linked in the description above the code block.
-
Unfortunately, sphinx doesn't forward the docs from the aliased class and it won't render the docstring for a type alias. I've updated the documentation here to link to the type hints for now, but once
qcs-sdk-pythonhas live docs, we can link to it directly.
Co-authored-by: Kalan <[email protected]>
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.
Description
closes #1707 and #1709