From 82de84d6a60c258735810a5d916ffb439487d124 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 1 Sep 2022 21:24:36 -0400 Subject: [PATCH] Get sphinx to build documentation --- README.rst | 12 ++---------- adafruit_pcf8575.py | 4 ++-- docs/index.rst | 6 +----- 3 files changed, 5 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index d6a0b8a..b9d90f9 100644 --- a/README.rst +++ b/README.rst @@ -37,18 +37,11 @@ This is easily achieved by downloading or individual libraries can be installed using `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 `_ +`Purchase one from the Adafruit shop `_ 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 `_. @@ -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 index df29681..f2d1345 100644 --- 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 ` +* `Adafruit PCF8575 GPIO Expander `_ **Software and Dependencies:** diff --git a/docs/index.rst b/docs/index.rst index f91fed8..442cd05 100644 --- 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 .. toctree:: :caption: Other Links