Merge pull request #5 from erictleung/start-documentation

Start documentation
erictleung · May 29, 2017 · 4fffa6a · 4fffa6a
2 parents 24ade3f + 70e0acb
commit 4fffa6a
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,15 @@
+****
+lalg
+****
+
+.. include:: overview.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :glob:
+    :maxdepth: 2
+    :caption: Contents:
+
+    Quickstart <quickstart>
diff --git a/docs/lalg.rst b/docs/lalg.rst
@@ -0,0 +1,27 @@
+lalg package
+============
+
+.. automodule:: lalg
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    lalg.test
+
+Submodules
+----------
+
+lalg\.vectors module
+--------------------
+
+.. automodule:: lalg.vectors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
diff --git a/docs/lalg.test.rst b/docs/lalg.test.rst
@@ -0,0 +1,20 @@
+lalg\.test package
+==================
+
+.. automodule:: lalg.test
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+lalg\.test\.test\_vectors module
+--------------------------------
+
+.. automodule:: lalg.test.test_vectors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -0,0 +1,20 @@
+Quickstart
+==========
+
+Requirements
+------------
+
+- Python 3
+- Numpy
+
+Installation
+------------
+
+Install from GitHub
+...................
+
+To get the latest version on GitHub::
+
+    git clone https://github.com/erictleung/lalg
+    cd lalg
+    pip install .