Merge pull request rigetti#10 from pkaralekas/grove-docs-navigation

Make the self-contained docs for each algorithm accessible from index and navigation
Huskyeder · Jan 10, 2017 · bcaa834 · bcaa834
2 parents e26f521 + 16cdd4b
commit bcaa834
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 74 deletions.
diff --git a/docs/algorithms.rst b/docs/algorithms.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,28 +3,32 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-==================================
-Welcome to Grove's documentation!
-==================================
-Grove is a python library containing quantum algorithms that uses
-`pyQuil <http://github.com/rigetticomputing/pyQuil>`_ and the
-`Rigetti Forest service <http://forest.rigetti.com>`_.
+=======================================
+Welcome to the Documentation for Grove!
+=======================================
+Grove is a open source Python library containing quantum algorithms that uses
+the quantum programming library `pyQuil <http://github.com/rigetticomputing/pyQuil>`_
+and the `Rigetti Forest <http://forest.rigetti.com>`_ toolkit.
 
 Structure
 _________
 
 Grove is organized into modules for the various quantum algorithms, each
-of which has self-contrained documentation.
+of which has its own self-contained documentation.
 
 .. toctree::
    :name: mastertoc
    :maxdepth: 2
 
    installation
-   algorithms
-
-Indices and tables
-==================
+   teleportation
+   vqe
+   qaoa
+   qft
+   phaseestimation
+
+Indices and Tables
+__________________
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -7,8 +7,8 @@ Dependencies
 
 Grove depends on a few scientific python packages as well as the python library for Quil:
 
-* numpy
-* scipy
+* NumPy
+* SciPy
 * `pyQuil <https://github.com/rigetticomputing/pyQuil.git>`_
 * NetworkX
 * Matplotlib
@@ -18,7 +18,7 @@ Optional
 * pytest (for testing)
 * mock
 
-**Numpy** and **Scipy** can be installed with `pip` (a python package manager). ::
+**NumPy** and **SciPy** can be installed with `pip` (a Python package manager). ::
 
     pip install numpy
     pip install scipy
@@ -28,7 +28,7 @@ Or using the Conda package manager ::
     conda install numpy
     conda install scipy
 
-**pyQuil** can be installed by changing directory to where you would like to keep
+**pyQuil** can be installed by changing directories to where you would like to store
 the pyQuil repository and running ::
 
     git clone https://github.com/rigetticomputing/pyQuil.git
@@ -37,7 +37,7 @@ the pyQuil repository and running ::
 
 
 You will need to make sure that your pyQuil installation is properly configured to run with a
-QVM or quantum processor. See the pyQuil documentation for instructions on how to do this.
+QVM or quantum processor (QPU). See the pyQuil documentation for instructions on how to do this.
 
 
 Grove Installation

diff --git a/docs/phaseestimation.rst b/docs/phaseestimation.rst
@@ -0,0 +1,10 @@
+==========================
+Phase Estimation Algorithm
+==========================
+
+.. toctree::
+   :name: mastertoc
+   :maxdepth: 3
+
+   phaseestimation/phaseestimation_overview
+   phaseestimation/pea_source
diff --git a/docs/phaseestimation/phaseestimation.rst b/docs/phaseestimation/phaseestimation.rst
diff --git a/docs/qaoa.rst b/docs/qaoa.rst
@@ -0,0 +1,12 @@
+=================================================
+Quantum Approximate Optimization Algorithm (QAOA)
+=================================================
+
+.. toctree::
+   :name: mastertoc
+   :maxdepth: 3
+
+   qaoa/qaoa_overview
+   qaoa/qaoa_installation_quickstart
+   qaoa/qaoa_algorithm_detail
+   qaoa/qaoa_sourcecode_docs
diff --git a/docs/qaoa/qaoa.rst b/docs/qaoa/qaoa.rst
diff --git a/docs/qft.rst b/docs/qft.rst
@@ -0,0 +1,10 @@
+===============================
+Quantum Fourier Transform (QFT)
+===============================
+
+.. toctree::
+   :name: mastertoc
+   :maxdepth: 3
+
+   qft/qft_overview
+   qft/qft_source
diff --git a/docs/qft/qft.rst b/docs/qft/qft.rst
diff --git a/docs/teleportation/teleportation.rst → docs/teleportation.rst b/docs/teleportation/teleportation.rst → docs/teleportation.rst
@@ -6,5 +6,5 @@ Quantum Teleportation
    :name: mastertoc
    :maxdepth: 3
 
-   teleportation_overview
-   teleportation_source 
+   teleportation/teleportation_overview
+   teleportation/teleportation_source
diff --git a/docs/vqe/vqe.rst → docs/vqe.rst b/docs/vqe/vqe.rst → docs/vqe.rst
@@ -1,6 +1,6 @@
-===================================
-The Variational-Quantum-Eigensolver
-===================================
+=====================================
+Variational-Quantum-Eigensolver (VQE)
+=====================================
 
 The Variational-Quantum-Eigensolver (VQE) [`1 <https://arxiv.org/abs/1304.3061>`_,
 `2 <https://arxiv.org/abs/1509.04279>`_] is a quantum/classical hybrid
@@ -48,5 +48,5 @@ makes use of the VQE module.
    :name: mastertoc
    :maxdepth: 3
 
-   vqe_example
-   vqe_source 
+   vqe/vqe_example
+   vqe/vqe_source
diff --git a/docs/vqe/vqe_source.rst b/docs/vqe/vqe_source.rst
@@ -1,11 +1,11 @@
 grove.pyvqe package
-=================
+===================
 
 Submodules
 ----------
 
 grove.pyvqe.vqe module
---------------------
+----------------------
 
 .. automodule:: grove.pyvqe.vqe
     :members: