Template for docs

andycasey · Nov 21, 2015 · 4110ee6 · 4110ee6
1 parent e03d898
commit 4110ee6
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 13 deletions.
diff --git a/docs/guide/cannon.rst b/docs/guide/cannon.rst
@@ -0,0 +1,6 @@
+.. _cannon:
+
+Using The Cannon
+================
+
+(Soon..)
diff --git a/docs/guide/compressed.rst b/docs/guide/compressed.rst
@@ -0,0 +1,6 @@
+.. _compressed:
+
+Using The Compressed Sensing Edition of The Cannon
+==================================================
+
+(Soon..)
diff --git a/docs/guide/custommodels.rst b/docs/guide/custommodels.rst
@@ -0,0 +1,6 @@
+.. _custommodels:
+
+Building Custom Cannon Models
+=============================
+
+(Soon..)
diff --git a/docs/guide/install.rst b/docs/guide/install.rst
@@ -0,0 +1,12 @@
+.. _install:
+
+Installation
+============
+
+The code is not currently registered through PyPI, so you will need to install
+it directly from the GitHub repository. This can be done using
+`pip <http://www.pip-installer.org/>`_.
+
+::
+    $ pip install https://github.com/andycasey/AnniesLasso/archive/master.zip 
+
diff --git a/docs/guide/quickstart.rst b/docs/guide/quickstart.rst
@@ -0,0 +1,6 @@
+.. _quickstart:
+
+Getting started
+===============
+
+(Soon..)
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,24 +1,32 @@
-.. Annie's Lasso documentation master file, created by
-   sphinx-quickstart on Sat Nov 21 16:48:50 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Annie's Lasso
+=============
 
-Welcome to Annie's Lasso's documentation!
-=========================================
+The Cannon 2: Compressed Sensing Edition
+----------------------------------------
 
-(Hello World?)
+Hello world?
 
-Contents:
+User Guide
+----------
 
 .. toctree::
    :maxdepth: 2
 
+   guide/install
+   guide/quickstart
+   guide/cannon
+   guide/compressed
+   guide/custommodels
 
+API Documentation
+-----------------
 
-Indices and tables
-==================
+.. toctree::
+   :maxdepth: 2
+
+   api
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+License
+-------
+Copyright 2015 the authors. Software made available under the MIT license.