Merge branch 'develop'

ccd-utexas · Jan 26, 2015 · 5796fbf · 5796fbf
2 parents 2cbc541 + 731a1a6
commit 5796fbf
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 9 deletions.
diff --git a/README.rst b/README.rst
@@ -8,34 +8,49 @@ Description
 
 See DESCRIPTION.rst.
 
+.. toctree::
+
+   DESCRIPTION
+
 Examples
 --------
 
 See repository `wiki <https://github.com/ccd-utexas/binstarsolver/wiki>`_.
 
+API Documentation
+-----------------
+
+.. toctree::
+
+   docs/index
+
 Installation
 ------------
 
-Use `Python Packaging Index <https://pypi.python.org/pypi>`_.
+Use `Python Packaging Index <https://pypi.python.org/pypi>`_:
 
 ::
 
-$ pip install binstarsolver
+   $ pip install binstarsolver
 
 Testing
 -------
 
-Use `pytest <https://pytest.org>`_.
+Use `pytest <https://pytest.org>`_:
 
 ::
 
-$ git clone https://github.com/ccd-utexas/binstarsolver.git
-$ cd binstarsolver
-$ git tag --list
-$ git checkout tags/<latest_tag_name>
-$ py.test
+   $ git clone https://github.com/ccd-utexas/binstarsolver.git
+   $ cd binstarsolver
+   $ git tag --list
+   $ git checkout tags/v0.1.2 # or latest tag name
+   $ py.test
 
 Contributing
 ------------
 
 See CONTRIBUTING.rst.
+
+.. toctree::
+
+   CONTRIBUTING
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,6 @@ Contents:
 
    modules
 
-
 Indices and tables
 ==================
 

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+numpydoc