Get sphinx to build documentation

adafruit · Sep 2, 2022 · 82de84d · 82de84d
1 parent f77840d
commit 82de84d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 17 deletions.
diff --git a/README.rst b/README.rst
@@ -37,18 +37,11 @@ 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/5611 >`_
+`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5611>`_
 
 
 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-pcf8575/>`_.
@@ -101,8 +94,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_pcf8575.py b/adafruit_pcf8575.py
@@ -4,7 +4,7 @@
 
 """
 `adafruit_pcf8575`
-================================================================================
+==================
 
 CircuitPython library for Adafruit PCF8575 GPIO expander
 
@@ -16,7 +16,7 @@
 
 **Hardware:**
 
-* `Adafruit PCF8575 GPIO Expander <https://www.adafruit.com/product/5611>`
+* `Adafruit PCF8575 GPIO Expander <https://www.adafruit.com/product/5611>`_
 
 **Software and Dependencies:**
 

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.
+    Adafruit PCF8575 GPIO Expander <https://www.adafruit.com/product/5611>
 
 .. toctree::
     :caption: Other Links