Merge pull request #14 from jposada202020/correcting_docs

improving_docs

Author: ladyada

README.rst

@@ -62,6 +62,8 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
+Examples of using this module are in examples folder.
+
 Contributing
 ============
 

adafruit_lc709203f.py

@@ -16,15 +16,20 @@
 
 **Hardware:**
 
- * Adafruit LC709023 Breakout: https://www.adafruit.com/product/4712
+* `Adafruit LC709203F LiPoly / LiIon Fuel Gauge and Battery Monitor
+  <https://www.adafruit.com/product/4712>`_ (Product ID: 4712)
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
+  https://circuitpython.org/downloads
+
+* Adafruit's Bus Device library:
+  https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+
+* Adafruit's Register library:
+  https://github.com/adafruit/Adafruit_CircuitPython_Register
 
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
 from micropython import const
@@ -100,7 +105,12 @@ class PackSize(CV):
 
 
 class LC709203F:
-    """Interface library for LC709203F battery monitoring and fuel gauge sensors"""
+    """Interface library for LC709203F battery monitoring and fuel gauge sensors
+
+    :param ~busio.I2C i2c_bus: The I2C bus the device is connected to
+    :param int address: The I2C device address. Defaults to :const:`0x0B`
+
+    """
 
     def __init__(self, i2c_bus, address=LC709203F_I2CADDR_DEFAULT):
         self.i2c_device = i2c_device.I2CDevice(i2c_bus, address)

docs/api.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: adafruit_lc709203f
    :members:
+   :exclude-members: CV

docs/examples.rst

@@ -6,3 +6,12 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/lc709203f_simpletest.py
     :caption: examples/lc709203f_simpletest.py
     :linenos:
+
+Thermistor test
+---------------
+
+Example showing the use of thermistors over I2C
+
+.. literalinclude:: ../examples/lc709203f_thermistortest.py
+    :caption: examples/lc709203f_thermistortest.py
+    :linenos:

docs/index.rst

@@ -23,6 +23,8 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    Adafruit LC709023 Breakout Learning Guide <https://learn.adafruit.com/adafruit-lc709203f-lipo-lipoly-battery-monitor/overview>
+
 .. toctree::
     :caption: Related Products