update to docs

wbierbower · Aug 17, 2015 · 98eceb0 · 98eceb0
1 parent 82c9e00
commit 98eceb0
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 30 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -28,7 +28,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 # -- General configuration ------------------------------------------------
 
@@ -40,6 +40,8 @@
 # ones.
 extensions = [
     'sphinx.ext.mathjax',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,23 +3,21 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to fauxgeo's documentation!
-===============================================
+Fauxgeo API
+===========
 
-Contents:
+  .. toctree::
+     :maxdepth: 1
 
-.. toctree::
-   :maxdepth: 2
+     modules/affine.rst
+     modules/raster.rst
+     modules/vector.rst
 
-   readme
-   installation
-   usage
-   history
+.. include:: ../../README.rst
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
diff --git a/docs/source/modules/affine.rst b/docs/source/modules/affine.rst
@@ -0,0 +1,9 @@
+Affine Module
+=============
+
+.. automodule:: fauxgeo.affine
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. End of file
diff --git a/docs/source/modules/raster.rst b/docs/source/modules/raster.rst
@@ -0,0 +1,9 @@
+Raster Module
+=============
+
+.. automodule:: fauxgeo.raster
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. End of file
diff --git a/docs/source/modules/vector.rst b/docs/source/modules/vector.rst
@@ -0,0 +1,9 @@
+Vector Module
+=============
+
+.. automodule:: fauxgeo.vector
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. End of file
diff --git a/docs/source/usage.rst b/docs/source/usage.rst