fix docs build

Author: FoamyGuy

README.rst

@@ -38,19 +38,10 @@ This is easily achieved by downloading
 or individual libraries can be installed using
 `circup <https://github.com/adafruit/circup>`_.
 
-
-
-.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
-image from the assets folder in the PCB's GitHub repo.
-
-`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6335>`_
+`Adafruit OPT4048 Tri-Stimulus XYZ Color and Lux Sensor <http://www.adafruit.com/products/6335>`_
 
 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-opt4048/>`_.
@@ -101,8 +92,28 @@ Or the following command to update an existing version:
 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.
+.. code-block:: python
+
+    import time
+    from time import sleep
+
+    import board
+
+    from adafruit_opt4048 import OPT4048, ConversionTime, Mode, Range
+
+    i2c = board.I2C()  # uses board.SCL and board.SDA
+    # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
+    sensor = OPT4048(i2c)
+
+    sensor.range = Range.AUTO
+    sensor.conversion_time = ConversionTime.TIME_100MS
+    sensor.mode = Mode.CONTINUOUS
+    while True:
+        x, y, lux = sensor.get_cie()
+        print(f"CIE x:{x}, y:{y}, lux: {lux}", end=" ")
+        print(f"K: {sensor.calculate_color_temperature(x,y)}")
+        time.sleep(1)
+
 
 Documentation
 =============

adafruit_opt4048.py

@@ -22,8 +22,9 @@
 
 * Adafruit CircuitPython firmware for the supported boards:
   https://circuitpython.org/downloads
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+
 """
 
 # imports
@@ -56,18 +57,6 @@
 class CV:
     """Constant value class helper for enums."""
 
-    # @classmethod
-    # def add_values(cls, value_tuples: Tuple[str, int, str, Optional[float]]) -> None:
-    #     """Add CV values to the class"""
-    #     cls.string = {}
-    #     cls.lsb = {}
-    #
-    #     for value_tuple in value_tuples:
-    #         name, value, string, lsb = value_tuple
-    #         setattr(cls, name, value)
-    #         cls.string[value] = string
-    #         cls.lsb[value] = lsb
-
     @classmethod
     def is_valid(cls, value: int) -> bool:
         """Validate that a given value is a member"""
@@ -78,6 +67,7 @@ def is_valid(cls, value: int) -> bool:
 
     @classmethod
     def get_name(cls, value) -> str:
+        """Get the name for a given value"""
         name_dict = {}
         for _key, _value in cls.__dict__.items():
             name_dict[_value] = _key

docs/examples.rst

@@ -6,3 +6,21 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/opt4048_simpletest.py
     :caption: examples/opt4048_simpletest.py
     :linenos:
+
+Webserial example
+-----------------
+
+Output color data over serial for use with webserial page
+
+.. literalinclude:: ../examples/opt4048_webserial.py
+    :caption: examples/opt4048_webserial.py
+    :linenos:
+
+Full test
+---------
+
+Comprehensive test of features
+
+.. literalinclude:: ../examples/opt4048_fulltest.py
+    :caption: examples/opt4048_fulltest.py
+    :linenos:

docs/index.rst

@@ -24,14 +24,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.
+    Adafruit OPT4048 Tri-Stimulus XYZ Color and Lux Sensor <http://www.adafruit.com/products/6335>
 
 .. toctree::
     :caption: Other Links