Added beter controls and an example. Improved documentation.

docs/docsrc/conf.py

@@ -10,16 +10,16 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath(f'..{os.sep}..'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'DisplayArray'
-copyright = '2019, Simulator Leek'
-author = 'Simulator Leek'
+project = "DisplayArray"
+copyright = "2019, Simulator Leek"
+author = "Simulator Leek"
 
 
 # -- General configuration ---------------------------------------------------
@@ -27,15 +27,15 @@ author = 'Simulator Leek'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']
+extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 add_module_names = False
 
@@ -45,9 +45,9 @@ add_module_names = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

docs/docsrc/crop.rst

@@ -1,7 +0,0 @@
-displayarray.effects.crop
-===================================
-
-.. currentmodule:: displayarray.effects.crop
-
-.. autoclass:: Crop
-    :members:

docs/docsrc/display.rst

@@ -1,12 +1,11 @@
-displayarray
+displayarray.display
 ===================================
 .. automodule:: displayarray
 
-Display
--------
 .. autofunction:: display
 .. autofunction:: breakpoint_display
 
-Frames
-------
-.. autofunction:: read_updates
+Windows
+-------
+.. autoclass:: displayarray.window.SubscriberWindows
+    :members:

docs/docsrc/effects.rst

@@ -0,0 +1,30 @@
+displayarray.effects
+====================
+
+Crop
+----
+.. currentmodule:: displayarray.effects.crop
+
+.. autoclass:: Crop
+    :members:
+
+Lens
+----
+.. currentmodule:: displayarray.effects.lens
+
+.. automodule:: displayarray.effects.lens
+   :members:
+
+.. autoclass:: Barrel
+    :members:
+
+.. autoclass:: Mustache
+    :members:
+
+Select Channels
+---------------
+.. currentmodule:: displayarray.effects.select_channels
+
+.. autoclass:: SelectChannels
+   :members:
+

docs/docsrc/frame.rst

@@ -1,6 +1,14 @@
 displayarray.frame
 ===================================
 
+Read Updates
+------------
+.. currentmodule:: displayarray
+
+.. autofunction:: read_updates
+
+Frame Passing
+-------------
 .. currentmodule:: displayarray.frame
 
 .. automodule:: displayarray.frame

docs/docsrc/index.rst

@@ -14,13 +14,10 @@ DisplayArray displays arrays.
    :maxdepth: 3
    :caption: Python API
 
-   displayarray
-   displayarray.effects.crop <crop>
-   displayarray.effects.lens <lens>
-   displayarray.effects.select_channels <select_channels>
-   displayarray.frame <frame>
-   displayarray.window <window>
-   displayarray.input <input>
+   display <display>
+   frame <frame>
+   effects <effects>
+   input <input>
 
 .. toctree::
    :maxdepth: 2

docs/docsrc/lens.rst

@@ -1,13 +0,0 @@
-displayarray.effects.lens
-============================
-
-.. currentmodule:: displayarray.effects.lens
-
-.. automodule:: displayarray.effects.lens
-   :members:
-
-.. autoclass:: Barrel
-    :members:
-
-.. autoclass:: Mustache
-    :members:

docs/docsrc/select_channels.rst

@@ -1,7 +0,0 @@
-displayarray.effects.select_channels
-======================================
-
-.. currentmodule:: displayarray.effects.select_channels
-
-.. autoclass:: SelectChannels
-   :members:

docs/docsrc/window.rst

@@ -1,7 +0,0 @@
-displayarray.window
-===================================
-
-.. currentmodule:: displayarray.window
-
-.. autoclass:: SubscriberWindows
-    :members: