Skip to content

Commit bc85429

Browse files
committed
fixes for sphinx
1 parent fba124b commit bc85429

File tree

3 files changed

+24
-22
lines changed

3 files changed

+24
-22
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Product page at `ti.com <http://www.ti.com/product/INA3221>`_.
1919

2020
2 version are available:
2121

22-
* full includes all constants for low-level register access + API for alarms
23-
* lite only basic API and no constants - use less memory
22+
* ``barbudor_ina3221.full`` includes all constants for low-level register access + API for alarms
23+
* ``barbudor_ina3221.lite`` only basic API and no constants - use less memory
2424

2525
Pick only one depending your needs. On processors with limited amount of memory (SAMD21), the
26-
lite version is recommended. You may want to use `mpy-cross` to precompile the library to an
27-
`.mpy` file for lower memory footprint.
26+
lite version is recommended. You may want to use ``mpy-cross`` to precompile the library to an
27+
``.mpy`` file for lower memory footprint.
2828

2929
Dependencies
3030
=============

barbudor_ina3221/full.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,30 @@
2020
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2121
# THE SOFTWARE.
2222
"""
23-
`barbudor_INA3221`
24-
====================================================
23+
`barbudor_INA3221.full <full>` - Full version library
24+
=====================================================
2525
26-
CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor.
26+
CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor
2727
28-
* Author : Barbudor (Jean-Michel Mercier)
28+
Author : Barbudor (Jean-Michel Mercier)
2929
3030
Implementation Notes
3131
--------------------
3232
33-
**Important Note:**
3433
In order to be coherent with the datasheet, the channel index in the below API start at 1.
3534
Value of ``channel`` parameter must be ``1``, ``2`` or ``3``. **Do not use** ``0``
3635
37-
Memory usage (tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express):
36+
**Memory usage:**
3837
39-
* from barbudor_ina3221 import INA3221 --> 6704 bytes
40-
* ina3221 = INA3221(i2c_bus) --> 112 bytes
38+
Tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express:
39+
40+
* ``from barbudor_ina3221 import INA3221`` => 6704 bytes
41+
* ``ina3221 = INA3221(i2c_bus)`` => 112 bytes
4142
4243
**Hardware:**
4344
4445
* Device: `INA3221 <http://www.ti.com/product/INA3221>`_ Triple, Low-/High-Side, I2C Out
45-
Current/Voltage Monitor.
46+
Current/Voltage Monitor.
4647
4748
**Software and Dependencies:**
4849

barbudor_ina3221/lite.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,30 @@
2020
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2121
# THE SOFTWARE.
2222
"""
23-
`barbudor_INA3221` -- lite version
24-
====================================================
23+
`barbudor_INA3221.lite <lite>` - Lite version library
24+
=====================================================
2525
26-
CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor.
26+
CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor
2727
28-
* Author : Barbudor (Jean-Michel Mercier)
28+
Author : Barbudor (Jean-Michel Mercier)
2929
3030
Implementation Notes
3131
--------------------
3232
33-
**Important Note**
3433
In order to be coherent with the datasheet, the channel index in the below API start at 1.
3534
Value of ``channel`` parameter must be ``1``, ``2`` or ``3``. **Do not use** ``0``
3635
37-
Memory usage (tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express):
36+
**Memory usage:**
3837
39-
* from barbudor_ina3221 import INA3221 --> 3200 bytes
40-
* ina3221 = INA3221(i2c_bus) --> 112 bytes
38+
Tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express:
39+
40+
* ``from barbudor_ina3221 import INA3221`` => 3200 bytes
41+
* ``ina3221 = INA3221(i2c_bus)`` => 112 bytes
4142
4243
**Hardware:**
4344
4445
* Device: `INA3221 <http://www.ti.com/product/INA3221>`_ Triple, Low-/High-Side, I2C Out
45-
Current/Voltage Monitor.
46+
Current/Voltage Monitor.
4647
4748
**Software and Dependencies:**
4849

0 commit comments

Comments
 (0)