Add README badge linking to stable documentation #339
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
Pull Request Test Coverage Report for Build 5686915283
💛 - Coveralls |
caleb-johnson
previously approved these changes
Jul 27, 2023
caleb-johnson
pushed a commit
that referenced
this pull request
Jul 28, 2023
* Add docs badge to link to stable docs * Add ruff badge * Remove ruff
caleb-johnson
added a commit
that referenced
this pull request
Aug 14, 2023
* Don't batch unnecessarily * mypy * black * Missing varname * fix bug * Clean up code * Improve comments * release note * release note * Update batch-by-sampler-c4ae836df9997b1d.yaml * Update batch-by-sampler-c4ae836df9997b1d.yaml * Update batch-by-sampler-c4ae836df9997b1d.yaml * Bump Python version in Dockerfile to 3.11 (#331) Now that CKT supports Python 3.11, we might as well use the latest version in the Dockerfile. * Fix formatting of example in `reduce_bitstrings` docstring (#332) * Implement cutting of general 2-qubit unitaries (#302) * Add support for `SwapGate` * Reorder terms [ci skip] * Add missing terms * DRY the coefficients * Fix coverage * Add support for `iSwapGate` * Fix black * Add to release note * Fix type hint * Gates without parameters are nicer to work with and can be singletons, one day! * Remove a line * Add comments describing channels * `_copy_unique_sublists` * Add `DCXGate` * Tweak * Implement cutting of general 2-qubit unitaries Builds on #294. Closes #186. * Add tests of additional gates * Fix type annotation * Add explanatory comments * `supported_gates()` -> `explicitly_supported_gates()` * Add to references * Improved error message and test about `to_matrix` conversion failing * Add xref to `QPDBasis` in docstrings * Add `qpdbasis_from_gate` to Sphinx build * Make `explicitly_supported_gates` private and remove its release note It's not clear that this function remains useful now that we support essentially all 2-qubit gates. If we find a use for it in the future, we can re-introduce it (or something like it) as a public interface. * Fix intersphinx link * Release note * Update qpd.py: remove extraneous `from None` * Improve the instructions regarding pandoc (#336) I've also tried to make the developer documentation easier to discover * Make the repository link more obvious from the Sphinx build (#338) * Make the repository link more obvious from the Sphinx build * Enable "edit" link in the header * Add comment * Add README badge linking to stable documentation (#339) * Add docs badge to link to stable docs * Add ruff badge * Remove ruff * Update README.md (#340) Making directions on opening the docs a little more succinct. * Change var name * Add SECURITY.md (#337) * Implement wire cutting as a two-qubit instruction (#174) * Implement wire cutting as a two-qubit instruction * Update type annotation * s/gate/instruction/ * Add overhead test for `Move` instruction * Add wire cutting tutorial * Add `Move` to Sphinx build * Doc updates suggested by Caleb * Add release note and link to new tutorial * Clarify wording following #174 (comment) * Improvements to `Move` docstring * Use svg as the plot format This avoids pixelation on high-dpi displays * Remove unnecessary uses of `CircuitInstruction` https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/pull/174/files#r1278067109 * The notebook tests should ignore any files that crop up in `docs/_build` `matplotlib.sphinxext.plot_directive` likes to leave python files there --------- Co-authored-by: Jim Garrison <garrison@ibm.com> Co-authored-by: Ibrahim Shehzad <75153717+IbrahimShehzad@users.noreply.github.com>
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.
This is complementary to #338, but in the reverse direction. I want to make sure the docs are easily discoverable from github if one does not know to look in the sidebar. I also added a ruff badge for good measure, but I could be convinced this is unnecessary. Preview at https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/docs-badge/README.md