-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add some explanation and example to circuit library documentation #7354
Conversation
Pull Request Test Coverage Report for Build 2190126833
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't actually built the documentation myself to check, but it would be good to do that and to ensure that all the inserted cross-references actually do link to the expected places.
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
I pushed a change to fix the docs build here. I had to remove the documenting of |
) * Add some explanation and example to circuit library * remove BooleanExpression * missing gates * standard and directives * title mod * generalized gates * boolean logic circuits * Basis Change Circuits and Arithmetic Circuits * section Amplitude Functions is duplicated. (maybe a bad merge in #5142?) * N-local and feature map * dup entry * Template circuits * ups * line too long * address #7354 (comment) * addressing #7354 (comment) * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * import to address #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Apply suggestions from code review Co-authored-by: Matthew Treinish <[email protected]> * directives * pretty colors * undo changes in standard_gates/__init__.py * operations * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * example * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Fix Sphinx errors * Fix duplicate definitions and indentation * Fix typo Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: Matthew Treinish <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit aee0dc4)
) (#7955) * Add some explanation and example to circuit library * remove BooleanExpression * missing gates * standard and directives * title mod * generalized gates * boolean logic circuits * Basis Change Circuits and Arithmetic Circuits * section Amplitude Functions is duplicated. (maybe a bad merge in #5142?) * N-local and feature map * dup entry * Template circuits * ups * line too long * address #7354 (comment) * addressing #7354 (comment) * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * import to address #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Apply suggestions from code review Co-authored-by: Matthew Treinish <[email protected]> * directives * pretty colors * undo changes in standard_gates/__init__.py * operations * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * example * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Fix Sphinx errors * Fix duplicate definitions and indentation * Fix typo Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: Matthew Treinish <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit aee0dc4) Co-authored-by: Luciano Bello <[email protected]>
Summary
In Qiskit/qiskit.org#2009 there is a redesign of the qiskit.org main page where one of aspect to highlight from Qiskit is the Circuit Library:
The
Learn more ->
link in the Circuit Library box will point to https://qiskit.org/documentation/apidoc/circuit_library.html However, this page is a bit rough for the newcomer. This PR is an attempt to create a slightly more welcomed place, with a short explanation on what's the library and how to use it.Comments on how to do that are very much welcomed.
Details and comments
In addition to add a paragraph (mostly copied from https://qiskit.org/overview#circuits) and an example, I also included:
Standard Instructions