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

Jump to bottom

Add Migration Guide for qiskit.algorithms #9557

Merged
merged 25 commits into from
Apr 5, 2023
Merged

Add Migration Guide for qiskit.algorithms #9557

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
25 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
7579e61
Add algos guide
ElePT Feb 8, 2023
ca899ef
Add skeleton
ElePT Feb 10, 2023
d59b8a1
Add content
ElePT Feb 23, 2023
1fc46e9
Fix sampling VQE example
ElePT Feb 23, 2023
c0ef6e6
Merge branch 'main' into algos-migration-guide
woodsp-ibm Mar 9, 2023
0489207
Merge branch 'main' into algos-migration-guide
woodsp-ibm Mar 10, 2023
f29d729
Apply suggestions from Steve's code review
ElePT Mar 13, 2023
c780a4f
Apply review, update code examples up to Eigensolvers
ElePT Mar 13, 2023
96b0b03
Add doctest to sphinx config
ElePT Mar 13, 2023
4e8b920
Fix conflict
ElePT Mar 13, 2023
9c20038
Merge branch 'Qiskit:main' into algos-migration-guide
ElePT Mar 14, 2023
c1444e5
Add tests up to eigensolvers
ElePT Mar 14, 2023
8552394
Merge branch 'algos-migration-guide' of https://github.com/ElePT/qisk…
ElePT Mar 14, 2023
569ba19
Review code examples from Eigensolvers
ElePT Mar 14, 2023
68a2592
Update heading style
ElePT Mar 14, 2023
cc09bd0
Merge branch 'main' into algos-migration-guide
woodsp-ibm Mar 27, 2023
701561b
Apply suggestions from Declan's code review
ElePT Mar 30, 2023
cd1c143
Apply suggestions from Steve's code review
ElePT Mar 31, 2023
0d562c1
Apply review
ElePT Mar 31, 2023
93ae38b
Merge branch 'algos-migration-guide' of https://github.com/ElePT/qisk…
ElePT Mar 31, 2023
b5a2942
Final changes, fix docs
ElePT Apr 3, 2023
14fee7e
Apply Julien's comments
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
8 changes: 8 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

# -- General configuration ---------------------------------------------------
import datetime
import doctest

project = "Qiskit"
copyright = f"2017-{datetime.date.today().year}, Qiskit Development Team" # pylint: disable=redefined-builtin
Expand All @@ -37,7 +38,9 @@
"reno.sphinxext",
"sphinx_design",
"matplotlib.sphinxext.plot_directive",
"sphinx.ext.doctest"
]

templates_path = ["_templates"]

# Number figures, tables and code-blocks if they have a caption.
Expand All @@ -62,6 +65,7 @@

intersphinx_mapping = {
"retworkx": ("https://qiskit.org/documentation/retworkx/", None),
"qiskit_ibm_runtime": ("https://qiskit.org/documentation/partners/qiskit_ibm_runtime/", None)
}

# -- Options for HTML output -------------------------------------------------
Expand Down Expand Up @@ -108,3 +112,7 @@
}

autoclass_content = "both"

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

doctest_default_flags = doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | doctest.IGNORE_EXCEPTION_DETAIL | doctest.DONT_ACCEPT_TRUE_FOR_1
3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Qiskit Terra documentation

API References <apidocs/terra>
Release Notes <release_notes>

Migration Guides <migration_guides/index>

.. Hiding - Indices and tables
:ref:`genindex`
:ref:`modindex`
Expand Down
Loading