Update for sphinx build

adafruit · Aug 23, 2022 · 90cab0a · 90cab0a
1 parent 1c08b08
commit 90cab0a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 16 deletions.
diff --git a/README.rst b/README.rst
@@ -38,18 +38,13 @@ 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.
+Works with the GUVx family of I2C UV light sensors
 
 `Purchase one from the Adafruit shop <http://www.adafruit.com/products/5609>`_
 
 
 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-guvx-i2c/>`_.
@@ -102,8 +97,7 @@ 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.
+See the `examples/` folder for usage examples.
 
 Documentation
 =============

diff --git a/adafruit_guvx_i2c.py b/adafruit_guvx_i2c.py
@@ -17,8 +17,7 @@
 
 **Hardware:**
 
-.. todo:: Add links to any specific hardware product page(s), or category page(s).
-  Use unordered list & hyperlink rST inline format: "* `Link Text <url>`_"
+* `GUVx UV light sensor <http://www.adafruit.com/products/5609>`_
 
 **Software and Dependencies:**
 

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -3,6 +3,6 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/guvx_i2c_simpletest.py
+.. literalinclude:: ../examples/guvb_c31sm_simpletest.py
     :caption: examples/guvx_i2c_simpletest.py
     :linenos:
diff --git a/docs/index.rst b/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.
+    GUVx sensor <http://www.adafruit.com/products/5609>
 
 .. toctree::
     :caption: Other Links