some minor fixes to SimpleCV docstrings and addition of docs

SimpleCV/SimpleCV.py

@@ -601,10 +601,10 @@ def drawCircle(self, ctr, rad, color = (0,0,0), thickness = 1):
   def drawLine(self, pt1, pt2, color = (0,0,0), thickness = 1):
     """
     Draw a line on the Image, parameters include
-    *pt1 - the first point for the line (tuple)
-    *pt1 - the second point on the line (tuple)
-    *a color tuple (default black)
-    *thickness of the line 
+    * pt1 - the first point for the line (tuple)
+    * pt1 - the second point on the line (tuple)
+    * a color tuple (default black)
+    * thickness of the line 
  
     Note that this modifies the image in-place and clears all buffers.
     """
@@ -1031,11 +1031,11 @@ def draw(self, color = (255, 0, 0)):
 
 class Blob(Feature):
   """
-  The Blob Feature is a wrapper for the cvblob-python library.  
+The Blob Feature is a wrapper for the cvblob-python library.  
 
-  The findBlobs function returns contiguous regions of light-colored area, given an intensity threshold.  The Blob class helps you map the position, volume, and shape of these areas.  The coordinates of the Blob are its centroid, and its area is defined by its total pixel count.
+The findBlobs() function returns contiguous regions of light-colored area, given an intensity threshold.  The Blob class helps you map the position, volume, and shape of these areas.  The coordinates of the Blob are its centroid, and its area is defined by its total pixel count.
 
-  Blob implements all of the Feature properties, and its core data structure, cvblob has the following properties (from cvblob.h):
+Blob implements all of the Feature properties, and its core data structure, cvblob has the following properties (from cvblob.h)::
 
     CvLabel label; ///< Label assigned to the blob.
     
@@ -1072,10 +1072,12 @@ class Blob(Feature):
     CvContourChainCode contour;           ///< Contour.
     CvContoursChainCode internalContours; ///< Internal contours. 
 
-  For more information:
-    http://github.com/oostendo/cvblob-python
-    http://code.google.com/p/cvblob
-    http://code.google.com/p/cvblob/source/browse/trunk/cvBlob/cvblob.h 
+
+For more information:
+
+* http://github.com/oostendo/cvblob-python
+* http://code.google.com/p/cvblob
+* http://code.google.com/p/cvblob/source/browse/trunk/cvBlob/cvblob.h 
   """
   cvblob = ""
 

doc/Makefile

@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  qthelp    to make HTML files and a qthelp project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SimpleCV.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SimpleCV.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

doc/README

@@ -0,0 +1,8 @@
+to build docs, install SimpleCV and run::
+    make html
+
+or simply run::
+    PYTHONPATH=$PYTHONPATH:.. make html
+
+in this directory
+

doc/api.rst

@@ -0,0 +1,86 @@
+:mod:`SimpleCV` module
+======================
+
+.. automodule:: SimpleCV
+
+Image
+--------
+
+.. autoclass:: Image 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+
+Features
+--------
+
+
+.. autoclass:: FeatureSet 
+   :members:
+
+.. autoclass:: Feature
+   :members:
+
+.. autoclass:: Corner 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+.. autoclass:: Line
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+.. autoclass:: HaarFeature 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+.. autoclass:: Blob 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+.. autoclass:: Barcode 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+Cameras
+--------
+
+.. autoclass:: Camera
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+.. autoclass:: Kinect 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+.. autoclass:: VirtualCamera 
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+
+Streams
+---------
+
+.. autoclass:: JpegStreamer
+   :show-inheritance:
+   :members:
+   :inherited-members:
+   :undoc-members:
+