Skip to content

Commit 34596eb

Browse files
committed
dox-ing
1 parent 76cf6f3 commit 34596eb

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

README.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,23 @@ To install in a virtual environment in your current project:
5656
Usage Example
5757
=============
5858

59-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
59+
.. code-block:: python3
60+
61+
import time
62+
import board
63+
import busio
64+
import adafruit_dps310
65+
66+
i2c = busio.I2C(board.SCL, board.SDA)
67+
68+
dps310 = adafruit_dps310.DPS310(i2c)
69+
70+
while True:
71+
print("Temperature = %.2f *C"%dps310.temperature)
72+
print("Pressure = %.2f hPa"%dps310.pressure)
73+
print("")
74+
time.sleep(1.0)
75+
6076
6177
Contributing
6278
============

adafruit_dps310.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
2626
Library for the DPS310 Precision Barometric Pressure Sensor
2727
28-
2928
* Author(s): Bryan Siepert
3029
3130
Implementation Notes

docs/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,10 @@ Table of Contents
2323
.. toctree::
2424
:caption: Tutorials
2525

26-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
27-
the toctree above for use later.
2826

2927
.. toctree::
3028
:caption: Related Products
3129

32-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
33-
the toctree above for use later.
3430

3531
.. toctree::
3632
:caption: Other Links

0 commit comments

Comments
 (0)