Get sphinx to build documentation

adafruit · Aug 30, 2022 · 8ee988d · 8ee988d
1 parent c8a5eb2
commit 8ee988d
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 21 deletions.
diff --git a/README.rst b/README.rst
@@ -38,18 +38,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/5606>`_
 
 
 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-ens160/>`_.
@@ -102,8 +95,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_ens160.py b/adafruit_ens160.py
@@ -15,8 +15,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>`_"
+* `ScioSense ENS160 multi-gas sensor <http://www.adafruit.com/products/5606>`_
 
 **Software and Dependencies:**
 
@@ -105,7 +104,7 @@ class ENS160:
     interrupt_enable = RWBit(_ENS160_REG_CONFIG, 0)
 
     def __init__(self, i2c_bus: I2C, address: int = ENS160_I2CADDR_DEFAULT) -> None:
-        # pylint: disable=no-member
+
         self.i2c_device = i2c_device.I2CDevice(i2c_bus, address)
 
         self.reset()

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.
+    ScioSense ENS160 multi-gas sensor <http://www.adafruit.com/products/5606>
 
 .. toctree::
     :caption: Other Links

diff --git a/pyproject.toml b/pyproject.toml
@@ -46,10 +46,6 @@ classifiers = [
 dynamic = ["dependencies", "optional-dependencies"]
 
 [tool.setuptools]
-# You can just specify the packages manually here if your project is
-# simple. Or you can use find_packages().
-# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
-#       CHANGE `py_modules = ['...']` TO `packages = ['...']`
 py-modules = ["adafruit_ens160"]
 
 [tool.setuptools.dynamic]