Update docs to include api, design, and tutorial sections

wbierbower · Sep 15, 2015 · c67e7a7 · c67e7a7
1 parent 58e0ea4
commit c67e7a7
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 39 deletions.
diff --git a/docs/source/modules/affine.rst → docs/source/api/affine.rst b/docs/source/modules/affine.rst → docs/source/api/affine.rst
@@ -1,7 +1,7 @@
-Affine Module
-=============
+Affine Class
+============
 
-.. automodule:: fauxgeo.affine
+.. autoclass:: fauxgeo.Affine
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -0,0 +1,10 @@
+===
+API
+===
+
+.. toctree::
+    :maxdepth: 2
+
+    raster.rst
+    raster_factory.rst
+    affine.rst
diff --git a/docs/source/modules/raster.rst → docs/source/api/raster.rst b/docs/source/modules/raster.rst → docs/source/api/raster.rst
@@ -1,7 +1,7 @@
-Raster Module
-=============
+Raster Class
+============
 
-.. automodule:: fauxgeo.raster
+.. autoclass:: fauxgeo.Raster
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/source/api/raster_factory.rst b/docs/source/api/raster_factory.rst
@@ -0,0 +1,9 @@
+RasterFactory Class
+===================
+
+.. autoclass:: fauxgeo.RasterFactory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. End of file
diff --git a/docs/source/modules/vector.rst → docs/source/api/vector.rst b/docs/source/modules/vector.rst → docs/source/api/vector.rst
@@ -1,7 +1,7 @@
-Vector Module
-=============
+Vector Class
+============
 
-.. automodule:: fauxgeo.vector
+.. autoclass:: fauxgeo.Vector
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/source/design/design.rst b/docs/source/design/design.rst
@@ -0,0 +1,3 @@
+======
+Design
+======
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,30 +1,26 @@
-.. fauxgeo documentation master file, created by
-   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+=====================
+Fauxgeo Documentation
+=====================
 
-Fauxgeo API
-===========
+**Features:**
 
-  .. toctree::
-     :maxdepth: 1
-
-     modules/affine.rst
-     modules/raster.rst
-     modules/raster_factory.rst
-     modules/vector.rst
+- Raster class
+- RasterStack class
+- RasterFactory class
+- Affine class
 
-.. include:: ../../README.rst
-
-Other Useful Info
-=================
+Documentation
+=============
 
   .. toctree::
-     :maxdepth: 1
+     :maxdepth: 2
 
-     tutorial.rst
+     api/api.rst
+     design/design.rst
+     tutorials/tutorials.rst
      history.rst
 
+
 Indices and tables
 ==================
 

diff --git a/docs/source/modules/raster_factory.rst b/docs/source/modules/raster_factory.rst
diff --git a/docs/source/tutorials/tutorials.rst b/docs/source/tutorials/tutorials.rst
@@ -0,0 +1,8 @@
+=========
+Tutorials
+=========
+
+.. toctree::
+    :maxdepth: 2
+
+    unittests.rst
diff --git a/docs/source/tutorial.rst → docs/source/tutorials/unittests.rst b/docs/source/tutorial.rst → docs/source/tutorials/unittests.rst
@@ -1,5 +1,5 @@
-Unit Testing with Fauxgeo
-=========================
+Creating Rasters for Unittests
+==============================
 
 .. code::