Migrate tutorials from qiskit-tutorials and update content.

Quick update of content Add aer to requirements-dev.txt Add networkx to requirements-dev.txt Fix spelling Recover grover try pin sphinx Delete IQPE Apply review comments Use short urls Apply comments from code review Update tweedledum reqs Add thumbnails to metadata Add try-except Fix gradients tag Default thumbnail Update docs/tutorials/02_vqe_advanced_options.ipynb Co-authored-by: Steve Wood <[email protected]> Update docs/tutorials/02_vqe_advanced_options.ipynb Co-authored-by: Steve Wood <[email protected]> Update docs/tutorials/05_qaoa.ipynb Co-authored-by: Steve Wood <[email protected]> Update docs/tutorials/10_pvqd.ipynb Co-authored-by: Steve Wood <[email protected]> Apply suggestions Documentation fixes and updates (#36) Co-authored-by: Elena Peña Tapia <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Remove pin
qiskit-community · Aug 21, 2023 · 548cf80 · 548cf80
1 parent 934b961
commit 548cf80
Show file tree

Hide file tree

Showing 31 changed files with 1,986 additions and 2,537 deletions.
diff --git a/.pylintdict b/.pylintdict
@@ -28,6 +28,7 @@ bfgs
 bielza
 bitstring
 bitstrings
+bloch
 boltzmann
 bool
 boyer
@@ -101,6 +102,7 @@ fmin
 formatter
 fourier
 frac
+frobenius
 f'spsa
 ftol
 fujii
@@ -112,18 +114,21 @@ gaussian
 generalised
 getter
 getters
+gilliam
 giuseppe
 globals
 gogolin
 goldfarb
 goldstone
+gonciulea
 gqt
 grinko
 grover
 gsls
 gtol
 gutmann
 hadamard
+hadamards
 hadfield
 hamiltonian
 hamiltonians
@@ -170,6 +175,7 @@ lin
 linalg
 loglik
 loglikelihood
+lov
 lr
 lsb
 lse
@@ -200,6 +206,7 @@ nakanishi
 nan
 nannicini
 nathan
+nd
 ndarray
 negoro
 nelder
@@ -286,6 +293,7 @@ runarsson
 rz
 sanjiv
 sashank
+satisfiability
 satyen
 schrödinger
 schroediger
@@ -334,6 +342,7 @@ toctree
 todo
 tol
 trainability
+transpilation
 transpile
 transpiled
 trotterization
@@ -349,6 +358,7 @@ vec
 vectorized
 vicentini
 ville
+voilà
 vqd
 vqe
 wavefunction

diff --git a/docs/apidocs/qiskit_algorithms.AlgorithmError.rst b/docs/apidocs/qiskit_algorithms.AlgorithmError.rst
@@ -0,0 +1,6 @@
+AlgorithmError
+==============
+
+.. currentmodule:: qiskit_algorithms
+
+.. autoexception:: AlgorithmError
diff --git a/docs/apidocs/qiskit_algorithms.gradients.rst b/docs/apidocs/qiskit_algorithms.gradients.rst
@@ -0,0 +1,6 @@
+.. _qiskit_algorithms-gradients:
+
+.. automodule:: qiskit_algorithms.gradients
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/qiskit_algorithms.optimizers.rst b/docs/apidocs/qiskit_algorithms.optimizers.rst
@@ -0,0 +1,6 @@
+.. _qiskit_algorithms-optimizers:
+
+.. automodule:: qiskit_algorithms.optimizers
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/algorithms.rst → docs/apidocs/qiskit_algorithms.rst b/docs/apidocs/algorithms.rst → docs/apidocs/qiskit_algorithms.rst
diff --git a/docs/apidocs/qiskit_algorithms.state_fidelities.rst b/docs/apidocs/qiskit_algorithms.state_fidelities.rst
@@ -0,0 +1,6 @@
+.. _qiskit_algorithms-state_fidelities:
+
+.. automodule:: qiskit_algorithms.state_fidelities
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/qiskit_algorithms.time_evolvers.trotterization.rst b/docs/apidocs/qiskit_algorithms.time_evolvers.trotterization.rst
@@ -0,0 +1,6 @@
+.. _qiskit_algorithms-time_evolvers-trotterization:
+
+.. automodule:: qiskit_algorithms.time_evolvers.trotterization
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/qiskit_algorithms.time_evolvers.variational.rst b/docs/apidocs/qiskit_algorithms.time_evolvers.variational.rst
@@ -0,0 +1,6 @@
+.. _qiskit_algorithms-time_evolvers-variational:
+
+.. automodule:: qiskit_algorithms.time_evolvers.variational
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -24,7 +24,7 @@ Next Steps
 
   Overview <self>
   Getting Started <getting_started>
-  API References <apidocs/algorithms>
+  API References <apidocs/qiskit_algorithms>
   Tutorials <tutorials/index>
   Release Notes <release_notes>
   GitHub <https://github.com/qiskit-community/qiskit-algorithms>

diff --git a/docs/tutorials/01_algorithms_introduction.ipynb b/docs/tutorials/01_algorithms_introduction.ipynb
diff --git a/docs/tutorials/02_vqe_advanced_options.ipynb b/docs/tutorials/02_vqe_advanced_options.ipynb
diff --git a/docs/tutorials/03_vqe_simulation_with_noise.ipynb b/docs/tutorials/03_vqe_simulation_with_noise.ipynb
diff --git a/docs/tutorials/04_vqd.ipynb b/docs/tutorials/04_vqd.ipynb
diff --git a/docs/tutorials/05_qaoa.ipynb b/docs/tutorials/05_qaoa.ipynb
diff --git a/docs/tutorials/06_grover.ipynb b/docs/tutorials/06_grover.ipynb
diff --git a/docs/tutorials/07_grover_examples.ipynb b/docs/tutorials/07_grover_examples.ipynb
diff --git a/docs/tutorials/09_IQPE.ipynb b/docs/tutorials/09_IQPE.ipynb
diff --git a/docs/tutorials/10_pvqd.ipynb b/docs/tutorials/10_pvqd.ipynb
diff --git a/docs/tutorials/11_VarQTE.ipynb b/docs/tutorials/11_VarQTE.ipynb
diff --git a/docs/tutorials/12_gradients_framework.ipynb b/docs/tutorials/12_gradients_framework.ipynb