Refactored the docs to collect all algorithm-specific information in …

…individual pages
rigetti · Jan 13, 2017 · 4891331 · 4891331
1 parent f54fdc9
commit 4891331
Show file tree

Hide file tree

Showing 28 changed files with 946 additions and 984 deletions.
diff --git a/docs/phaseestimation.rst b/docs/phaseestimation.rst
@@ -1,10 +1,27 @@
-==========================
 Phase Estimation Algorithm
 ==========================
 
-.. toctree::
-   :name: mastertoc
-   :maxdepth: 3
+Overview
+--------
+
+The phase estimation algorithm is a quantum subroutine useful for finding the
+eigenvalue corresponding to an eigenvector \\(u\\) of some unitary operator.
+It is the starting point for many other algorithms and relies on the inverse
+quantum Fourier transform.  More details can be found in references [1]_.
+
+Source Code Docs
+----------------
+
+Here you can find documentation for the different submodules in phaseestimation.
+
+grove.phaseestimation.phase_estimation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: grove.phaseestimation.phase_estimation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. rubric:: References
 
-   phaseestimation/phaseestimation_overview
-   phaseestimation/pea_source
+.. [1] Nielsen, Michael A., and Isaac L. Chuang. Quantum Computation and Quantum Information. Cambridge University Press, 2010.
diff --git a/docs/phaseestimation/pea_source.rst b/docs/phaseestimation/pea_source.rst
diff --git a/docs/phaseestimation/phaseestimation_overview.rst b/docs/phaseestimation/phaseestimation_overview.rst