From 90cab0ac4984cd89ab3faec46c7fde071180cf99 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 23:37:41 -0400 Subject: [PATCH] Update for sphinx build --- README.rst | 10 ++-------- adafruit_guvx_i2c.py | 3 +-- docs/examples.rst | 2 +- docs/index.rst | 6 +----- 4 files changed, 5 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 91a1523..ea4935b 100644 --- a/README.rst +++ b/README.rst @@ -38,18 +38,13 @@ 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. +Works with the GUVx family of I2C UV light sensors `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 `_. @@ -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 index 92e0e61..258e329 100644 --- 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 `_" +* `GUVx UV light sensor `_ **Software and Dependencies:** diff --git a/docs/examples.rst b/docs/examples.rst index 8aba719..9f64742 100644 --- 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 index d59b960..07701ad 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. + GUVx sensor .. toctree:: :caption: Other Links