fixes for pre-commit and sphinx

Author: FoamyGuy

README.rst

@@ -36,10 +36,7 @@ This is easily achieved by downloading
 or individual libraries can be installed using
 `circup <https://github.com/adafruit/circup>`_.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.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-displayio_annotation/>`_.
@@ -69,8 +66,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 scripts in the examples directory of this repository.
 
 Contributing
 ============

displayio_annotation.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 """
 
-`annotation`
+`displayio_annotation`
 ================================================================================
 A widget for annotating other widgets or freeform positions.
 
@@ -21,7 +21,7 @@
 
 """
 
-# pylint: disable=too-many-arguments, too-many-locals, unused-argument
+# pylint: disable=too-many-arguments, too-many-locals, unused-argument, too-few-public-methods
 
 from terminalio import FONT
 from adafruit_display_text import bitmap_label
@@ -31,7 +31,7 @@
 
 class Annotation(Widget):
     """A widget to be used to annotate other widgets with text and lines, but can also
-     be used freeform by using ``(x,y)`` parameter.
+    be used freeform by using ``(x,y)`` parameter.
 
     :param int x: x-direction pixel position for the end of the annotation line for
      freeform positioning, ``(x,y)`` will be ignored if a ``widget`` and ``anchor_point`` and/or
@@ -93,7 +93,7 @@ class Annotation(Widget):
       annotations (using ``widget`` and ``anchor_point`` input parameters) and a
       freeform annotation (using ``x`` and ``y`` input parameters).
 
-      File location: *examples/displayio_layout_annotation_simpletest.py*
+      File location: *examples/displayio_annotation_simpletest.py*
     """
 
     def __init__(

docs/api.rst

@@ -5,5 +5,5 @@
 .. use this format as the module name: "adafruit_foo.foo"
 
 .. automodule:: displayio_annotation
-   :members:
+    :members:
     :member-order: bysource

docs/conf.py

@@ -25,7 +25,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 = ["terminalio"]
+autodoc_mock_imports = ["terminalio", "vectorio", "bitmaptools"]
 
 
 intersphinx_mapping = {

docs/index.rst

@@ -24,14 +24,11 @@ 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.
+    DisplayIO Basics <https://learn.adafruit.com/circuitpython-display-support-using-displayio>
 
 .. 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

setup.py

@@ -56,7 +56,7 @@
     ],
     # What does your project relate to?
     keywords="adafruit blinka circuitpython micropython displayio_annotation displayio widget "
-             "graphics",
+    "graphics",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,