doco improvements

Author: petercorke

docs/source/conf.py

@@ -13,7 +13,7 @@
 import os
 import sys
 
-# sys.path.insert(0, os.path.abspath('../../machinevisiontoolbox'))
+sys.path.insert(0, os.path.abspath("../.."))
 sys.path.append(os.path.abspath("exts"))
 print(os.path.abspath("exts"))
 

docs/source/image_class.rst

@@ -1,6 +1,7 @@
 .. currentmodule:: machinevisiontoolbox.Image
 
 .. _image_class_label:
+
 The ``Image`` object for image operations and processing
 ========================================================
 
@@ -11,9 +12,8 @@ An :class:`~machinevisiontoolbox.ImageCore.Image` instance has a very large numb
 operations on an image and wrap low-level operations performed using NumPy or
 OpenCV.
 
-.. autoclass:: machinevisiontoolbox.ImageCore.Image
-	:special-members: __init__
-   :no-index:
+.. autoclass:: machinevisiontoolbox.Image
+   :special-members: __init__
 
 Image attributes and datatype
 -----------------------------
@@ -132,6 +132,7 @@ Extract sub-images or planes from an ``Image`` instance.
    ~green
    ~blue
    ~__getitem__
+   ~pixel
 
 Color info
 ^^^^^^^^^^

docs/source/kernel.rst

@@ -3,6 +3,9 @@
 Image kernels
 =============
 
+.. autoclass: Kernel
+    :special-members: __init__
+
 .. autosummary:: Kernel
     :nosignatures:
     :toctree: stubs/kernel

docs/source/support-classes.rst

@@ -3,52 +3,45 @@
 Supporting classes
 ==================
 
-Convolution kernel class
-------------------------
-
-.. autoclass:: ImageSpatial.Kernel
-    :members:
-    :special-members:
 
 Image feature classes
 ---------------------
 
 Whole image features
 ^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: ImageWholeFeatures.Histogram
+.. autoclass:: Histogram
     :members:
     :special-members:
 
 
 Fiducial features
 ^^^^^^^^^^^^^^^^^
 
-.. autoclass:: ImageRegionFeatures.Fiducial
+.. autoclass:: Fiducial
+    :members:
+    :special-members:
+
+Blob features
+^^^^^^^^^^^^^
+
+.. autoclass:: Blob
     :members:
+    :special-members:
+
+.. autoclass:: Blobs
+    :members:
+    :special-members:
 
 Line features
 ^^^^^^^^^^^^^
 
-.. autoclass:: ImageLineFeatures.HoughFeature
+.. autoclass:: HoughFeature
     :members:
 
 Point features
 ^^^^^^^^^^^^^^
 
-.. inheritance-diagram:: ImagePointFeatures.SIFTFeature
-      ImagePointFeatures.ORBFeature
-      ImagePointFeatures.BRISKFeature
-      ImagePointFeatures.AKAZEFeature
-      ImagePointFeatures.HarrisFeature
-      ImagePointFeatures.FREAKFeature
-      ImagePointFeatures.BOOSTFeature
-      ImagePointFeatures.BRIEFFeature
-      ImagePointFeatures.LATCHFeature
-      ImagePointFeatures.LUCIDFeature
-    :top-classes: ImagePointFeatures.BaseFeature2D
-    :parts: 1
-
 .. autosummary::
     :toctree: stubs
     :nosignatures:
@@ -65,6 +58,26 @@ Point features
     ~ImagePointFeatures.LUCIDFeature
     ~ImagePointFeatures.HarrisFeature
 
+
+.. inheritance-diagram:: ImagePointFeatures.SIFTFeature
+      ImagePointFeatures.ORBFeature
+      ImagePointFeatures.BRISKFeature
+      ImagePointFeatures.AKAZEFeature
+      ImagePointFeatures.HarrisFeature
+      ImagePointFeatures.FREAKFeature
+      ImagePointFeatures.BOOSTFeature
+      ImagePointFeatures.BRIEFFeature
+      ImagePointFeatures.LATCHFeature
+      ImagePointFeatures.LUCIDFeature
+    :top-classes: ImagePointFeatures.BaseFeature2D
+    :parts: 1
+
 .. autoclass:: ImagePointFeatures.BaseFeature2D
     :members:
 
+Convolution kernel class
+------------------------
+
+.. autoclass:: Kernel
+    :members:
+    :special-members: