update readme, update library, sphinx builds

Author: brentru

README.rst

@@ -13,8 +13,8 @@ Introduction
     :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor
     :alt: Build Status
 
-Simulated mouse cursor for display interaction
-
+Mouse cursor for interaction with CircuitPython UI elements such as
+`buttons <https://github.com/adafruit/Adafruit_CircuitPython_Display_Button>`_.
 
 Dependencies
 =============
@@ -31,9 +31,6 @@ Installing from PyPI
 .. note:: This library is not available on PyPI yet. Install documentation is included
    as a standard element. Stay tuned for PyPI availability!
 
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
-
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-cursor/>`_. To install for current user:
 
@@ -59,7 +56,7 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+See examples in examples/ folder.
 
 Contributing
 ============

adafruit_cursor.py

@@ -30,38 +30,38 @@
 Implementation Notes
 --------------------
 
-**Hardware:**
-
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
   https://github.com/adafruit/circuitpython/releases
 """
+import displayio
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git"
 
 class Cursor:
     """Mouse cursor interaction for CircuitPython.
 
-    :param displayio.Display: CircuitPython display object.
-    :param displayio.Group: CircuitPython group object to append the cursor to.
+    :param ~displayio.Display display: CircuitPython display object.
+    :param ~displayio.Group display_group: CircuitPython group object to append the cursor to.
     :param int cursor_speed: Speed of the cursor, in pixels.
-    ;param int scale: Scale amount for the cursor in both directions.
+    :param int scale: Scale amount for the cursor in both directions.
     :param bool is_hidden: Cursor is hidden on init.
 
-    Example for creating a cursor layer:
+    Example for creating a cursor layer
+
     .. code-block:: python
-    import adafruit_cursor
-    # Create the display
-    display = board.DISPLAY
 
-    # Create the display context
-    splash = displayio.Group(max_size=22)
+        import adafruit_cursor
+        # Create the display
+        display = board.DISPLAY
 
-    # initialize the mouse cursor object
-    mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash)
+        # Create the display context
+        splash = displayio.Group(max_size=22)
 
+        # initialize the mouse cursor object
+        mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash)
     """
     # pylint: disable=too-many-arguments
     def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1):

docs/conf.py

@@ -20,7 +20,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["displayio"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/index.rst

@@ -23,14 +23,10 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
 
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
 
 .. toctree::
     :caption: Other Links