DEVOPS-584 Move SimpleCV.org to read the docs.

sightmachine · Apr 6, 2015 · 2fc0a36 · 2fc0a36
1 parent 8c7d06f
commit 2fc0a36
Show file tree

Hide file tree

Showing 52 changed files with 365 additions and 273 deletions.
diff --git a/doc/SimpleCV.Camera.rst b/doc/SimpleCV.Camera.rst
@@ -0,0 +1,6 @@
+SimpleCV.Camera module
+======================
+
+.. automodule:: SimpleCV.Camera
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Color.rst b/doc/SimpleCV.Color.rst
@@ -0,0 +1,6 @@
+SimpleCV.Color module
+=====================
+
+.. automodule:: SimpleCV.Color
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.ColorModel.rst b/doc/SimpleCV.ColorModel.rst
@@ -0,0 +1,6 @@
+SimpleCV.ColorModel module
+==========================
+
+.. automodule:: SimpleCV.ColorModel
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.DFT.rst b/doc/SimpleCV.DFT.rst
@@ -0,0 +1,6 @@
+SimpleCV.DFT module
+===================
+
+.. automodule:: SimpleCV.DFT
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Display.rst b/doc/SimpleCV.Display.rst
@@ -0,0 +1,6 @@
+SimpleCV.Display module
+=======================
+
+.. automodule:: SimpleCV.Display
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.DrawingLayer.rst b/doc/SimpleCV.DrawingLayer.rst
@@ -0,0 +1,6 @@
+SimpleCV.DrawingLayer module
+============================
+
+.. automodule:: SimpleCV.DrawingLayer
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.BOFFeatureExtractor.rst b/doc/SimpleCV.Features.BOFFeatureExtractor.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.BOFFeatureExtractor module
+============================================
+
+.. automodule:: SimpleCV.Features.BOFFeatureExtractor
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.Blob.rst b/doc/SimpleCV.Features.Blob.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.Blob module
+=============================
+
+.. automodule:: SimpleCV.Features.Blob
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.BlobMaker.rst b/doc/SimpleCV.Features.BlobMaker.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.BlobMaker module
+==================================
+
+.. automodule:: SimpleCV.Features.BlobMaker
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.Detection.rst b/doc/SimpleCV.Features.Detection.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.Detection module
+==================================
+
+.. automodule:: SimpleCV.Features.Detection
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.EdgeHistogramFeatureExtractor.rst b/doc/SimpleCV.Features.EdgeHistogramFeatureExtractor.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.EdgeHistogramFeatureExtractor module
+======================================================
+
+.. automodule:: SimpleCV.Features.EdgeHistogramFeatureExtractor
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.FaceRecognizer.rst b/doc/SimpleCV.Features.FaceRecognizer.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.FaceRecognizer module
+=======================================
+
+.. automodule:: SimpleCV.Features.FaceRecognizer
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.FeatureExtractorBase.rst b/doc/SimpleCV.Features.FeatureExtractorBase.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.FeatureExtractorBase module
+=============================================
+
+.. automodule:: SimpleCV.Features.FeatureExtractorBase
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.FeatureUtils.rst b/doc/SimpleCV.Features.FeatureUtils.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.FeatureUtils module
+=====================================
+
+.. automodule:: SimpleCV.Features.FeatureUtils
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.Features.rst b/doc/SimpleCV.Features.Features.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.Features module
+=================================
+
+.. automodule:: SimpleCV.Features.Features
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.HaarCascade.rst b/doc/SimpleCV.Features.HaarCascade.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.HaarCascade module
+====================================
+
+.. automodule:: SimpleCV.Features.HaarCascade
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.HaarLikeFeature.rst b/doc/SimpleCV.Features.HaarLikeFeature.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.HaarLikeFeature module
+========================================
+
+.. automodule:: SimpleCV.Features.HaarLikeFeature
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.HaarLikeFeatureExtractor.rst b/doc/SimpleCV.Features.HaarLikeFeatureExtractor.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.HaarLikeFeatureExtractor module
+=================================================
+
+.. automodule:: SimpleCV.Features.HaarLikeFeatureExtractor
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.HueHistogramFeatureExtractor.rst b/doc/SimpleCV.Features.HueHistogramFeatureExtractor.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.HueHistogramFeatureExtractor module
+=====================================================
+
+.. automodule:: SimpleCV.Features.HueHistogramFeatureExtractor
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.MorphologyFeatureExtractor.rst b/doc/SimpleCV.Features.MorphologyFeatureExtractor.rst
@@ -0,0 +1,6 @@
+SimpleCV.Features.MorphologyFeatureExtractor module
+===================================================
+
+.. automodule:: SimpleCV.Features.MorphologyFeatureExtractor
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.Features.rst b/doc/SimpleCV.Features.rst
@@ -1,107 +1,29 @@
-Features Package
-================
-
-:mod:`Features` Package
------------------------
+SimpleCV.Features package
+=========================
+
+Submodules
+----------
+
+.. toctree::
+
+   SimpleCV.Features.BOFFeatureExtractor
+   SimpleCV.Features.Blob
+   SimpleCV.Features.BlobMaker
+   SimpleCV.Features.Detection
+   SimpleCV.Features.EdgeHistogramFeatureExtractor
+   SimpleCV.Features.FaceRecognizer
+   SimpleCV.Features.FeatureExtractorBase
+   SimpleCV.Features.FeatureUtils
+   SimpleCV.Features.Features
+   SimpleCV.Features.HaarCascade
+   SimpleCV.Features.HaarLikeFeature
+   SimpleCV.Features.HaarLikeFeatureExtractor
+   SimpleCV.Features.HueHistogramFeatureExtractor
+   SimpleCV.Features.MorphologyFeatureExtractor
+
+Module contents
+---------------
 
 .. automodule:: SimpleCV.Features
     :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`BOFFeatureExtractor` Module
----------------------------------
-
-.. automodule:: SimpleCV.Features.BOFFeatureExtractor
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`Blob` Module
-------------------
-
-.. automodule:: SimpleCV.Features.Blob
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`BlobMaker` Module
------------------------
-
-.. automodule:: SimpleCV.Features.BlobMaker
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`Detection` Module
------------------------
-
-.. automodule:: SimpleCV.Features.Detection
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`EdgeHistogramFeatureExtractor` Module
--------------------------------------------
-
-.. automodule:: SimpleCV.Features.EdgeHistogramFeatureExtractor
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`FeatureExtractorBase` Module
-----------------------------------
-
-.. automodule:: SimpleCV.Features.FeatureExtractorBase
-    :members:
-    :undoc-members:
     :show-inheritance:
-
-:mod:`Features` Module
-----------------------
-
-.. automodule:: SimpleCV.Features.Features
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`HaarCascade` Module
--------------------------
-
-.. automodule:: SimpleCV.Features.HaarCascade
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`HaarLikeFeature` Module
------------------------------
-
-.. automodule:: SimpleCV.Features.HaarLikeFeature
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`HaarLikeFeatureExtractor` Module
---------------------------------------
-
-.. automodule:: SimpleCV.Features.HaarLikeFeatureExtractor
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`HueHistogramFeatureExtractor` Module
-------------------------------------------
-
-.. automodule:: SimpleCV.Features.HueHistogramFeatureExtractor
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`MorphologyFeatureExtractor` Module
-----------------------------------------
-
-.. automodule:: SimpleCV.Features.MorphologyFeatureExtractor
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
diff --git a/doc/SimpleCV.Font.rst b/doc/SimpleCV.Font.rst
@@ -0,0 +1,6 @@
+SimpleCV.Font module
+====================
+
+.. automodule:: SimpleCV.Font
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.ImageClass.rst b/doc/SimpleCV.ImageClass.rst
@@ -0,0 +1,6 @@
+SimpleCV.ImageClass module
+==========================
+
+.. automodule:: SimpleCV.ImageClass
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.LineScan.rst b/doc/SimpleCV.LineScan.rst
@@ -0,0 +1,6 @@
+SimpleCV.LineScan module
+========================
+
+.. automodule:: SimpleCV.LineScan
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.ConfusionMatrix.rst b/doc/SimpleCV.MachineLearning.ConfusionMatrix.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.ConfusionMatrix module
+===============================================
+
+.. automodule:: SimpleCV.MachineLearning.ConfusionMatrix
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.KNNClassifier.rst b/doc/SimpleCV.MachineLearning.KNNClassifier.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.KNNClassifier module
+=============================================
+
+.. automodule:: SimpleCV.MachineLearning.KNNClassifier
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.NaiveBayesClassifier.rst b/doc/SimpleCV.MachineLearning.NaiveBayesClassifier.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.NaiveBayesClassifier module
+====================================================
+
+.. automodule:: SimpleCV.MachineLearning.NaiveBayesClassifier
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.SVMClassifier.rst b/doc/SimpleCV.MachineLearning.SVMClassifier.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.SVMClassifier module
+=============================================
+
+.. automodule:: SimpleCV.MachineLearning.SVMClassifier
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.ShapeContextClassifier.rst b/doc/SimpleCV.MachineLearning.ShapeContextClassifier.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.ShapeContextClassifier module
+======================================================
+
+.. automodule:: SimpleCV.MachineLearning.ShapeContextClassifier
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.TemporalColorTracker.rst b/doc/SimpleCV.MachineLearning.TemporalColorTracker.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.TemporalColorTracker module
+====================================================
+
+.. automodule:: SimpleCV.MachineLearning.TemporalColorTracker
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.TreeClassifier.rst b/doc/SimpleCV.MachineLearning.TreeClassifier.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.TreeClassifier module
+==============================================
+
+.. automodule:: SimpleCV.MachineLearning.TreeClassifier
+    :members:
+    :show-inheritance:
diff --git a/doc/SimpleCV.MachineLearning.TurkingModule.rst b/doc/SimpleCV.MachineLearning.TurkingModule.rst
@@ -0,0 +1,6 @@
+SimpleCV.MachineLearning.TurkingModule module
+=============================================
+
+.. automodule:: SimpleCV.MachineLearning.TurkingModule
+    :members:
+    :show-inheritance: