From 2fc0a362c8bec17c9d9e1a09df05dc8837185e0b Mon Sep 17 00:00:00 2001 From: Kirill Rozin Date: Mon, 6 Apr 2015 17:47:00 +0300 Subject: [PATCH] DEVOPS-584 Move SimpleCV.org to read the docs. --- doc/SimpleCV.Camera.rst | 6 + doc/SimpleCV.Color.rst | 6 + doc/SimpleCV.ColorModel.rst | 6 + doc/SimpleCV.DFT.rst | 6 + doc/SimpleCV.Display.rst | 6 + doc/SimpleCV.DrawingLayer.rst | 6 + doc/SimpleCV.Features.BOFFeatureExtractor.rst | 6 + doc/SimpleCV.Features.Blob.rst | 6 + doc/SimpleCV.Features.BlobMaker.rst | 6 + doc/SimpleCV.Features.Detection.rst | 6 + ...Features.EdgeHistogramFeatureExtractor.rst | 6 + doc/SimpleCV.Features.FaceRecognizer.rst | 6 + ...SimpleCV.Features.FeatureExtractorBase.rst | 6 + doc/SimpleCV.Features.FeatureUtils.rst | 6 + doc/SimpleCV.Features.Features.rst | 6 + doc/SimpleCV.Features.HaarCascade.rst | 6 + doc/SimpleCV.Features.HaarLikeFeature.rst | 6 + ...leCV.Features.HaarLikeFeatureExtractor.rst | 6 + ....Features.HueHistogramFeatureExtractor.rst | 6 + ...CV.Features.MorphologyFeatureExtractor.rst | 6 + doc/SimpleCV.Features.rst | 128 ++++-------------- doc/SimpleCV.Font.rst | 6 + doc/SimpleCV.ImageClass.rst | 6 + doc/SimpleCV.LineScan.rst | 6 + ...mpleCV.MachineLearning.ConfusionMatrix.rst | 6 + ...SimpleCV.MachineLearning.KNNClassifier.rst | 6 + ...V.MachineLearning.NaiveBayesClassifier.rst | 6 + ...SimpleCV.MachineLearning.SVMClassifier.rst | 6 + ...MachineLearning.ShapeContextClassifier.rst | 6 + ...V.MachineLearning.TemporalColorTracker.rst | 6 + ...impleCV.MachineLearning.TreeClassifier.rst | 6 + ...SimpleCV.MachineLearning.TurkingModule.rst | 6 + doc/SimpleCV.MachineLearning.rst | 52 +++---- ...impleCV.Segmentation.ColorSegmentation.rst | 6 + ...SimpleCV.Segmentation.DiffSegmentation.rst | 6 + doc/SimpleCV.Segmentation.MOGSegmentation.rst | 6 + ...pleCV.Segmentation.RunningSegmentation.rst | 6 + ...SimpleCV.Segmentation.SegmentationBase.rst | 6 + doc/SimpleCV.Segmentation.rst | 49 ++----- doc/SimpleCV.Stream.rst | 6 + doc/SimpleCV.Tracking.CAMShiftTracker.rst | 6 + doc/SimpleCV.Tracking.LKTracker.rst | 6 + doc/SimpleCV.Tracking.MFTracker.rst | 6 + doc/SimpleCV.Tracking.SURFTracker.rst | 6 + doc/SimpleCV.Tracking.TrackClass.rst | 6 + doc/SimpleCV.Tracking.TrackSet.rst | 6 + doc/SimpleCV.Tracking.rst | 21 +++ doc/SimpleCV.base.rst | 6 + doc/SimpleCV.rst | 107 +++------------ doc/conf.py | 3 +- doc/index.rst | 7 +- doc/modules.rst | 7 - 52 files changed, 365 insertions(+), 273 deletions(-) create mode 100644 doc/SimpleCV.Camera.rst create mode 100644 doc/SimpleCV.Color.rst create mode 100644 doc/SimpleCV.ColorModel.rst create mode 100644 doc/SimpleCV.DFT.rst create mode 100644 doc/SimpleCV.Display.rst create mode 100644 doc/SimpleCV.DrawingLayer.rst create mode 100644 doc/SimpleCV.Features.BOFFeatureExtractor.rst create mode 100644 doc/SimpleCV.Features.Blob.rst create mode 100644 doc/SimpleCV.Features.BlobMaker.rst create mode 100644 doc/SimpleCV.Features.Detection.rst create mode 100644 doc/SimpleCV.Features.EdgeHistogramFeatureExtractor.rst create mode 100644 doc/SimpleCV.Features.FaceRecognizer.rst create mode 100644 doc/SimpleCV.Features.FeatureExtractorBase.rst create mode 100644 doc/SimpleCV.Features.FeatureUtils.rst create mode 100644 doc/SimpleCV.Features.Features.rst create mode 100644 doc/SimpleCV.Features.HaarCascade.rst create mode 100644 doc/SimpleCV.Features.HaarLikeFeature.rst create mode 100644 doc/SimpleCV.Features.HaarLikeFeatureExtractor.rst create mode 100644 doc/SimpleCV.Features.HueHistogramFeatureExtractor.rst create mode 100644 doc/SimpleCV.Features.MorphologyFeatureExtractor.rst create mode 100644 doc/SimpleCV.Font.rst create mode 100644 doc/SimpleCV.ImageClass.rst create mode 100644 doc/SimpleCV.LineScan.rst create mode 100644 doc/SimpleCV.MachineLearning.ConfusionMatrix.rst create mode 100644 doc/SimpleCV.MachineLearning.KNNClassifier.rst create mode 100644 doc/SimpleCV.MachineLearning.NaiveBayesClassifier.rst create mode 100644 doc/SimpleCV.MachineLearning.SVMClassifier.rst create mode 100644 doc/SimpleCV.MachineLearning.ShapeContextClassifier.rst create mode 100644 doc/SimpleCV.MachineLearning.TemporalColorTracker.rst create mode 100644 doc/SimpleCV.MachineLearning.TreeClassifier.rst create mode 100644 doc/SimpleCV.MachineLearning.TurkingModule.rst create mode 100644 doc/SimpleCV.Segmentation.ColorSegmentation.rst create mode 100644 doc/SimpleCV.Segmentation.DiffSegmentation.rst create mode 100644 doc/SimpleCV.Segmentation.MOGSegmentation.rst create mode 100644 doc/SimpleCV.Segmentation.RunningSegmentation.rst create mode 100644 doc/SimpleCV.Segmentation.SegmentationBase.rst create mode 100644 doc/SimpleCV.Stream.rst create mode 100644 doc/SimpleCV.Tracking.CAMShiftTracker.rst create mode 100644 doc/SimpleCV.Tracking.LKTracker.rst create mode 100644 doc/SimpleCV.Tracking.MFTracker.rst create mode 100644 doc/SimpleCV.Tracking.SURFTracker.rst create mode 100644 doc/SimpleCV.Tracking.TrackClass.rst create mode 100644 doc/SimpleCV.Tracking.TrackSet.rst create mode 100644 doc/SimpleCV.Tracking.rst create mode 100644 doc/SimpleCV.base.rst delete mode 100644 doc/modules.rst diff --git a/doc/SimpleCV.Camera.rst b/doc/SimpleCV.Camera.rst new file mode 100644 index 000000000..20bf3435d --- /dev/null +++ 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 new file mode 100644 index 000000000..371c7d82e --- /dev/null +++ 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 new file mode 100644 index 000000000..38d8859bb --- /dev/null +++ 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 new file mode 100644 index 000000000..922643e3f --- /dev/null +++ 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 new file mode 100644 index 000000000..12378afba --- /dev/null +++ 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 new file mode 100644 index 000000000..8956c6381 --- /dev/null +++ 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 new file mode 100644 index 000000000..725d1b623 --- /dev/null +++ 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 new file mode 100644 index 000000000..95c278c2e --- /dev/null +++ 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 new file mode 100644 index 000000000..b1ac5fffc --- /dev/null +++ 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 new file mode 100644 index 000000000..7a632a68a --- /dev/null +++ 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 new file mode 100644 index 000000000..b2a4d9c2e --- /dev/null +++ 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 new file mode 100644 index 000000000..9f9372642 --- /dev/null +++ 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 new file mode 100644 index 000000000..cda04138c --- /dev/null +++ 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 new file mode 100644 index 000000000..716fc6486 --- /dev/null +++ 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 new file mode 100644 index 000000000..1e6e233e6 --- /dev/null +++ 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 new file mode 100644 index 000000000..bb02a5a16 --- /dev/null +++ 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 new file mode 100644 index 000000000..27f4b01e7 --- /dev/null +++ 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 new file mode 100644 index 000000000..1e3d5d452 --- /dev/null +++ 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 new file mode 100644 index 000000000..95eb8071d --- /dev/null +++ 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 new file mode 100644 index 000000000..5fe3ef24a --- /dev/null +++ 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 index 3c6026c4c..9cc2df8e2 100644 --- 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 new file mode 100644 index 000000000..eb3c5e61b --- /dev/null +++ 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 new file mode 100644 index 000000000..0dca55962 --- /dev/null +++ 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 new file mode 100644 index 000000000..7857e4df3 --- /dev/null +++ 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 new file mode 100644 index 000000000..5a1bc7d58 --- /dev/null +++ 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 new file mode 100644 index 000000000..1cb39304e --- /dev/null +++ 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 new file mode 100644 index 000000000..baa41f9d9 --- /dev/null +++ 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 new file mode 100644 index 000000000..07b1b78c6 --- /dev/null +++ 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 new file mode 100644 index 000000000..4e40e88bc --- /dev/null +++ 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 new file mode 100644 index 000000000..9235bcae6 --- /dev/null +++ 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 new file mode 100644 index 000000000..8ddd1b630 --- /dev/null +++ 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 new file mode 100644 index 000000000..1892ee838 --- /dev/null +++ b/doc/SimpleCV.MachineLearning.TurkingModule.rst @@ -0,0 +1,6 @@ +SimpleCV.MachineLearning.TurkingModule module +============================================= + +.. automodule:: SimpleCV.MachineLearning.TurkingModule + :members: + :show-inheritance: diff --git a/doc/SimpleCV.MachineLearning.rst b/doc/SimpleCV.MachineLearning.rst index 21ea7411f..ba716e22f 100644 --- a/doc/SimpleCV.MachineLearning.rst +++ b/doc/SimpleCV.MachineLearning.rst @@ -1,43 +1,23 @@ -MachineLearning Package -======================= +SimpleCV.MachineLearning package +================================ -:mod:`MachineLearning` Package ------------------------------- +Submodules +---------- -.. automodule:: SimpleCV.MachineLearning - :members: - :undoc-members: - :show-inheritance: - -:mod:`KNNClassifier` Module ---------------------------- - -.. automodule:: SimpleCV.MachineLearning.KNNClassifier - :members: - :undoc-members: - :show-inheritance: - -:mod:`NaiveBayesClassifier` Module ----------------------------------- +.. toctree:: -.. automodule:: SimpleCV.MachineLearning.NaiveBayesClassifier - :members: - :undoc-members: - :show-inheritance: - -:mod:`SVMClassifier` Module ---------------------------- - -.. automodule:: SimpleCV.MachineLearning.SVMClassifier - :members: - :undoc-members: - :show-inheritance: + SimpleCV.MachineLearning.ConfusionMatrix + SimpleCV.MachineLearning.KNNClassifier + SimpleCV.MachineLearning.NaiveBayesClassifier + SimpleCV.MachineLearning.SVMClassifier + SimpleCV.MachineLearning.ShapeContextClassifier + SimpleCV.MachineLearning.TemporalColorTracker + SimpleCV.MachineLearning.TreeClassifier + SimpleCV.MachineLearning.TurkingModule -:mod:`TreeClassifier` Module ----------------------------- +Module contents +--------------- -.. automodule:: SimpleCV.MachineLearning.TreeClassifier +.. automodule:: SimpleCV.MachineLearning :members: - :undoc-members: :show-inheritance: - diff --git a/doc/SimpleCV.Segmentation.ColorSegmentation.rst b/doc/SimpleCV.Segmentation.ColorSegmentation.rst new file mode 100644 index 000000000..6d9e6ffde --- /dev/null +++ b/doc/SimpleCV.Segmentation.ColorSegmentation.rst @@ -0,0 +1,6 @@ +SimpleCV.Segmentation.ColorSegmentation module +============================================== + +.. automodule:: SimpleCV.Segmentation.ColorSegmentation + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Segmentation.DiffSegmentation.rst b/doc/SimpleCV.Segmentation.DiffSegmentation.rst new file mode 100644 index 000000000..e0fc770cb --- /dev/null +++ b/doc/SimpleCV.Segmentation.DiffSegmentation.rst @@ -0,0 +1,6 @@ +SimpleCV.Segmentation.DiffSegmentation module +============================================= + +.. automodule:: SimpleCV.Segmentation.DiffSegmentation + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Segmentation.MOGSegmentation.rst b/doc/SimpleCV.Segmentation.MOGSegmentation.rst new file mode 100644 index 000000000..72d21fb65 --- /dev/null +++ b/doc/SimpleCV.Segmentation.MOGSegmentation.rst @@ -0,0 +1,6 @@ +SimpleCV.Segmentation.MOGSegmentation module +============================================ + +.. automodule:: SimpleCV.Segmentation.MOGSegmentation + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Segmentation.RunningSegmentation.rst b/doc/SimpleCV.Segmentation.RunningSegmentation.rst new file mode 100644 index 000000000..16932bd37 --- /dev/null +++ b/doc/SimpleCV.Segmentation.RunningSegmentation.rst @@ -0,0 +1,6 @@ +SimpleCV.Segmentation.RunningSegmentation module +================================================ + +.. automodule:: SimpleCV.Segmentation.RunningSegmentation + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Segmentation.SegmentationBase.rst b/doc/SimpleCV.Segmentation.SegmentationBase.rst new file mode 100644 index 000000000..e8bd23e0d --- /dev/null +++ b/doc/SimpleCV.Segmentation.SegmentationBase.rst @@ -0,0 +1,6 @@ +SimpleCV.Segmentation.SegmentationBase module +============================================= + +.. automodule:: SimpleCV.Segmentation.SegmentationBase + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Segmentation.rst b/doc/SimpleCV.Segmentation.rst index d570d9d66..759aa873f 100644 --- a/doc/SimpleCV.Segmentation.rst +++ b/doc/SimpleCV.Segmentation.rst @@ -1,43 +1,20 @@ -Segmentation Package -==================== +SimpleCV.Segmentation package +============================= -:mod:`Segmentation` Package ---------------------------- +Submodules +---------- -.. automodule:: SimpleCV.Segmentation - :members: - :undoc-members: - :show-inheritance: - -:mod:`ColorSegmentation` Module -------------------------------- - -.. automodule:: SimpleCV.Segmentation.ColorSegmentation - :members: - :undoc-members: - :show-inheritance: - -:mod:`DiffSegmentation` Module ------------------------------- +.. toctree:: -.. automodule:: SimpleCV.Segmentation.DiffSegmentation - :members: - :undoc-members: - :show-inheritance: - -:mod:`RunningSegmentation` Module ---------------------------------- - -.. automodule:: SimpleCV.Segmentation.RunningSegmentation - :members: - :undoc-members: - :show-inheritance: + SimpleCV.Segmentation.ColorSegmentation + SimpleCV.Segmentation.DiffSegmentation + SimpleCV.Segmentation.MOGSegmentation + SimpleCV.Segmentation.RunningSegmentation + SimpleCV.Segmentation.SegmentationBase -:mod:`SegmentationBase` Module ------------------------------- +Module contents +--------------- -.. automodule:: SimpleCV.Segmentation.SegmentationBase +.. automodule:: SimpleCV.Segmentation :members: - :undoc-members: :show-inheritance: - diff --git a/doc/SimpleCV.Stream.rst b/doc/SimpleCV.Stream.rst new file mode 100644 index 000000000..0cf37eff8 --- /dev/null +++ b/doc/SimpleCV.Stream.rst @@ -0,0 +1,6 @@ +SimpleCV.Stream module +====================== + +.. automodule:: SimpleCV.Stream + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.CAMShiftTracker.rst b/doc/SimpleCV.Tracking.CAMShiftTracker.rst new file mode 100644 index 000000000..3a60d9d3e --- /dev/null +++ b/doc/SimpleCV.Tracking.CAMShiftTracker.rst @@ -0,0 +1,6 @@ +SimpleCV.Tracking.CAMShiftTracker module +======================================== + +.. automodule:: SimpleCV.Tracking.CAMShiftTracker + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.LKTracker.rst b/doc/SimpleCV.Tracking.LKTracker.rst new file mode 100644 index 000000000..9ace8422c --- /dev/null +++ b/doc/SimpleCV.Tracking.LKTracker.rst @@ -0,0 +1,6 @@ +SimpleCV.Tracking.LKTracker module +================================== + +.. automodule:: SimpleCV.Tracking.LKTracker + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.MFTracker.rst b/doc/SimpleCV.Tracking.MFTracker.rst new file mode 100644 index 000000000..b8fb79c7c --- /dev/null +++ b/doc/SimpleCV.Tracking.MFTracker.rst @@ -0,0 +1,6 @@ +SimpleCV.Tracking.MFTracker module +================================== + +.. automodule:: SimpleCV.Tracking.MFTracker + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.SURFTracker.rst b/doc/SimpleCV.Tracking.SURFTracker.rst new file mode 100644 index 000000000..935769259 --- /dev/null +++ b/doc/SimpleCV.Tracking.SURFTracker.rst @@ -0,0 +1,6 @@ +SimpleCV.Tracking.SURFTracker module +==================================== + +.. automodule:: SimpleCV.Tracking.SURFTracker + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.TrackClass.rst b/doc/SimpleCV.Tracking.TrackClass.rst new file mode 100644 index 000000000..3b8889fc0 --- /dev/null +++ b/doc/SimpleCV.Tracking.TrackClass.rst @@ -0,0 +1,6 @@ +SimpleCV.Tracking.TrackClass module +=================================== + +.. automodule:: SimpleCV.Tracking.TrackClass + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.TrackSet.rst b/doc/SimpleCV.Tracking.TrackSet.rst new file mode 100644 index 000000000..ea86a1905 --- /dev/null +++ b/doc/SimpleCV.Tracking.TrackSet.rst @@ -0,0 +1,6 @@ +SimpleCV.Tracking.TrackSet module +================================= + +.. automodule:: SimpleCV.Tracking.TrackSet + :members: + :show-inheritance: diff --git a/doc/SimpleCV.Tracking.rst b/doc/SimpleCV.Tracking.rst new file mode 100644 index 000000000..238a3aa1f --- /dev/null +++ b/doc/SimpleCV.Tracking.rst @@ -0,0 +1,21 @@ +SimpleCV.Tracking package +========================= + +Submodules +---------- + +.. toctree:: + + SimpleCV.Tracking.CAMShiftTracker + SimpleCV.Tracking.LKTracker + SimpleCV.Tracking.MFTracker + SimpleCV.Tracking.SURFTracker + SimpleCV.Tracking.TrackClass + SimpleCV.Tracking.TrackSet + +Module contents +--------------- + +.. automodule:: SimpleCV.Tracking + :members: + :show-inheritance: diff --git a/doc/SimpleCV.base.rst b/doc/SimpleCV.base.rst new file mode 100644 index 000000000..cda6674b6 --- /dev/null +++ b/doc/SimpleCV.base.rst @@ -0,0 +1,6 @@ +SimpleCV.base module +==================== + +.. automodule:: SimpleCV.base + :members: + :show-inheritance: diff --git a/doc/SimpleCV.rst b/doc/SimpleCV.rst index 363f13022..19d4ec262 100644 --- a/doc/SimpleCV.rst +++ b/doc/SimpleCV.rst @@ -1,94 +1,6 @@ -SimpleCV Package +SimpleCV package ================ -:mod:`SimpleCV` Package ------------------------ - -.. automodule:: SimpleCV.__init__ - :members: - :undoc-members: - :show-inheritance: - -:mod:`Camera` Module --------------------- - -.. automodule:: SimpleCV.Camera - :members: - :undoc-members: - :show-inheritance: - -:mod:`Color` Module -------------------- - -.. automodule:: SimpleCV.Color - :members: - :undoc-members: - :show-inheritance: - -:mod:`ColorModel` Module ------------------------- - -.. automodule:: SimpleCV.ColorModel - :members: - :undoc-members: - :show-inheritance: - -:mod:`Display` Module ---------------------- - -.. automodule:: SimpleCV.Display - :members: - :undoc-members: - :show-inheritance: - -:mod:`DrawingLayer` Module --------------------------- - -.. automodule:: SimpleCV.DrawingLayer - :members: - :undoc-members: - :show-inheritance: - -:mod:`EXIF` Module ------------------- - -.. automodule:: SimpleCV.EXIF - :members: - :undoc-members: - :show-inheritance: - -:mod:`Font` Module ------------------- - -.. automodule:: SimpleCV.Font - :members: - :undoc-members: - :show-inheritance: - -:mod:`ImageClass` Module ------------------------- - -.. automodule:: SimpleCV.ImageClass - :members: - :undoc-members: - :show-inheritance: - -:mod:`Stream` Module --------------------- - -.. automodule:: SimpleCV.Stream - :members: - :undoc-members: - :show-inheritance: - -:mod:`base` Module ------------------- - -.. automodule:: SimpleCV.base - :members: - :undoc-members: - :show-inheritance: - Subpackages ----------- @@ -97,4 +9,21 @@ Subpackages SimpleCV.Features SimpleCV.MachineLearning SimpleCV.Segmentation + SimpleCV.Tracking + +Submodules +---------- + +.. toctree:: + SimpleCV.Camera + SimpleCV.Color + SimpleCV.ColorModel + SimpleCV.DFT + SimpleCV.Display + SimpleCV.DrawingLayer + SimpleCV.Font + SimpleCV.ImageClass + SimpleCV.LineScan + SimpleCV.Stream + SimpleCV.base diff --git a/doc/conf.py b/doc/conf.py index 9cf9cf597..abc321eb3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -93,7 +93,8 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sightmachine' +# html_theme = 'sightmachine' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/index.rst b/doc/index.rst index eafbd56e7..670891a09 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,7 +5,7 @@ This is the online documentation for all of the SimpleCV functions. If you are l To access the documentation, click on the package name below or in the header bar above. This will show you all of the classes and methods defined for that package, and then you just click on the item that you're interested in. Help within the Shell:: - + # You can always get documentation from within the SimpleCV Shell as well by doing >>> img = Image('simplecv') >>> help(img) @@ -13,8 +13,13 @@ Help within the Shell:: >>> img? # documentation will output here, press 'q' to quit documentation mode + +API documentation +================== + .. toctree:: :maxdepth: 8 + :titlesonly: SimpleCV diff --git a/doc/modules.rst b/doc/modules.rst deleted file mode 100644 index b42f41eb1..000000000 --- a/doc/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -SimpleCV -======== - -.. toctree:: - :maxdepth: 4 - - SimpleCV