Skip to content
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.

Sign up for GitHub

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 Migration Guide for Opflow #9549

Merged
merged 56 commits into from
Apr 6, 2023
Merged

Add Migration Guide for Opflow #9549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
dc0fae8
Add draft
ElePT Feb 8, 2023
d728473
Remove qiskit
ElePT Feb 8, 2023
311d9bc
Apply review
ElePT Feb 8, 2023
4c1b2ce
Apply comments boxnote
ElePT Feb 8, 2023
fd294a6
Small edit
ElePT Feb 8, 2023
8c0a92b
Apply review
ElePT Feb 8, 2023
2be8b5a
Update up to primitive ops
ElePT Feb 9, 2023
b7c1fcc
Dump changes from sphinx repo
ElePT Feb 9, 2023
1bcf435
Add twisties
ElePT Feb 13, 2023
889f211
Update information, add examples
ElePT Feb 13, 2023
9c188e2
Formatting changes
ElePT Feb 13, 2023
ee03557
Simplify intro
ElePT Feb 13, 2023
2e2e972
Add links
ElePT Feb 13, 2023
36ff6c0
Add sampler example
ElePT Feb 13, 2023
cc8ae4b
Update docs/migration_guides/opflow_migration.rst
ElePT Feb 14, 2023
b0d01a2
Update docs/migration_guides/opflow_migration.rst
ElePT Feb 14, 2023
b47ede4
Update docs/migration_guides/opflow_migration.rst
ElePT Feb 14, 2023
d4bb2d9
Update docs/migration_guides/opflow_migration.rst
ElePT Feb 14, 2023
0a6bdb4
Update docs/migration_guides/opflow_migration.rst
ElePT Feb 14, 2023
8e3e7b5
Apply suggestions from code review
ElePT Feb 14, 2023
04ca165
Update CircuitOp
ElePT Feb 14, 2023
51bbf54
Applied suggestions locally
ElePT Feb 14, 2023
3a7559f
Merge branch 'opflow-migration-guide' of https://github.com/ElePT/qis…
ElePT Feb 14, 2023
d8fb029
Change format, links
ElePT Feb 14, 2023
568c0b3
Add grouping, algorithms link
ElePT Feb 16, 2023
d82739c
Fix indentation
ElePT Feb 16, 2023
ef5f412
Final review, add links
ElePT Feb 21, 2023
2368ab6
Add gradients
ElePT Feb 23, 2023
f67cd8b
Apply heading suggestions
ElePT Feb 27, 2023
b2b718d
Add tags
ElePT Feb 27, 2023
fefd4a6
Apply suggestions code review
ElePT Feb 27, 2023
a3c0c07
Correct code examples, add outputs
ElePT Feb 28, 2023
fc71532
Run code examples by doctest
ElePT Feb 28, 2023
d0eaace
Remove underscores
ElePT Feb 28, 2023
c298051
Apply suggestions second round of review
ElePT Mar 3, 2023
b8f6e98
Merge branch 'main' of https://github.com/ElePT/qiskit-terra into opf…
ElePT Mar 3, 2023
4d5c5a2
Add globals link
ElePT Mar 3, 2023
f297a5c
Merge branch 'opflow-migration-guide' of https://github.com/ElePT/qis…
ElePT Mar 3, 2023
94d0dcc
Change links to refs
ElePT Mar 3, 2023
5d504f3
Add dropdowns
ElePT Mar 3, 2023
15c35e2
Change doctest syntax, apply reviews
ElePT Mar 9, 2023
3bf3896
Try CI config
ElePT Mar 9, 2023
11a35a0
Add internal links
ElePT Mar 9, 2023
52d53f2
Fix lint, add doctest import
ElePT Mar 9, 2023
3794960
Fix cyclic import
ElePT Mar 10, 2023
7f2f9c7
Fix cyclic import
ElePT Mar 10, 2023
3f018e4
Merge branch 'main' into opflow-migration-guide
woodsp-ibm Mar 27, 2023
fd883c4
Apply suggestions from Declan's code review
ElePT Mar 31, 2023
dcf64fd
Merge branch 'main' into opflow-migration-guide
ElePT Apr 3, 2023
8c771ba
Update qiskit/quantum_info/__init__.py
ElePT Apr 3, 2023
bd336f5
Fix import
ElePT Apr 5, 2023
a5b8a73
Copy docs config from #9716
ElePT Apr 5, 2023
15b666a
Make black
ElePT Apr 5, 2023
fbc9c02
Merge from main, fix conflicts
ElePT Apr 5, 2023
c5ec2f2
Remove duplicate
ElePT Apr 5, 2023
1285e7a
Reorder
ElePT Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions docs/conf.py
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to leave a note here. #9716 is going to be merged soon, probably before this PR. It also added configuration for doctest so you will need to resolve any conflicts.

Copy link
Contributor Author

@ElePT ElePT Mar 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added #9716 as a blocker Copied over config from #9716

Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"sphinx.ext.viewcode",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.doctest",
"reno.sphinxext",
"sphinx_design",
"matplotlib.sphinxext.plot_directive",
Expand Down Expand Up @@ -65,7 +66,9 @@

intersphinx_mapping = {
"retworkx": ("https://qiskit.org/documentation/retworkx/", None),
"qiskit_ibm_runtime": ("https://qiskit.org/documentation/partners/qiskit_ibm_runtime/", None)
"qiskit-ibm-runtime": ("https://qiskit.org/documentation/partners/qiskit_ibm_runtime/", None),
"qiskit-aer": ("https://qiskit.org/documentation/aer/", None),
"numpy": ("https://numpy.org/doc/stable/", None)
}

# -- Options for HTML output -------------------------------------------------
Expand Down Expand Up @@ -113,6 +116,17 @@

autoclass_content = "both"

# -- Options for doctest -------------------------------------
# -- Options for Doctest --------------------------------------------------------

doctest_default_flags = doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | doctest.IGNORE_EXCEPTION_DETAIL | doctest.DONT_ACCEPT_TRUE_FOR_1
import sphinx.ext.doctest

# This option will make doctest ignore whitespace when testing code.
# It's specially important for circuit representation as it gives an
# error otherwise
doctest_default_flags = sphinx.ext.doctest.doctest.NORMALIZE_WHITESPACE

# Leaving this string empty disables testing of doctest blocks from docstrings.
# Doctest blocks are structures like this one:
# >> code
# output
doctest_test_doctest_blocks = ""
4 changes: 2 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Qiskit Terra documentation
:hidden:

API References <apidocs/terra>
Release Notes <release_notes>
Migration Guides <migration_guides/index>
ElePT marked this conversation as resolved.
Show resolved Hide resolved
ElePT marked this conversation as resolved.
Show resolved Hide resolved

Release Notes <release_notes>

.. Hiding - Indices and tables
:ref:`genindex`
:ref:`modindex`
Expand Down
5 changes: 3 additions & 2 deletions docs/migration_guides/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
=======================
#######################
Qiskit Migration Guides
=======================
#######################

.. toctree::
:maxdepth: 1

opflow_migration
algorithms_migration
Loading