fixed docs

Author: siddacious

README.rst

@@ -32,25 +32,20 @@ Usage Example
 
 .. code-block:: python
 
-	import time
-	import board
-	import busio
-
-	import adafruit_lsm303_accel
-
-	i2c = busio.I2C(board.SCL, board.SDA)
-	sensor = adafruit_lsm303_accel.LSM303_Accel(i2c)
-
-	while True:
-		raw_accel_x, raw_accel_y, raw_accel_z = sensor.raw_acceleration
-		accel_x, accel_y, accel_z = sensor.acceleration
-		raw_mag_x, raw_mag_y, raw_mag_z = sensor.raw_magnetic
-		mag_x, mag_y, mag_z = sensor.magnetic
-
-		print('Acceleration raw: ({0:6d}, {1:6d}, {2:6d}), (m/s^2): ({3:10.3f}, {4:10.3f}, {5:10.3f})'.format(raw_accel_x, raw_accel_y, raw_accel_z, accel_x, accel_y, accel_z))
-		print('Magnetometer raw: ({0:6d}, {1:6d}, {2:6d}), (gauss): ({3:10.3f}, {4:10.3f}, {5:10.3f})'.format(raw_mag_x, raw_mag_y, raw_mag_z, mag_x, mag_y, mag_z))
-		print('')
-		time.sleep(1.0)
+        import time
+        import board
+        import busio
+        import adafruit_lsm303_accel
+        
+        i2c = busio.I2C(board.SCL, board.SDA)
+        sensor = adafruit_lsm303_accel.LSM303_Accel(i2c)
+        
+        while True:
+            acc_x, acc_y, acc_z = sensor.acceleration
+        
+            print('Acceleration (m/s^2): ({0:10.3f}, {1:10.3f}, {2:10.3f})'.format(acc_x, acc_y, acc_z))
+            print('')
+            time.sleep(1.0)
 
 
 Contributing
@@ -106,4 +101,4 @@ Now, once you have the virtual environment activated:
 
 This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
 view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
-locally verify it will pass.
+locally verify it will pass.

adafruit_lsm303_accel.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_lsm303-accel`
+`adafruit_lsm303_accel`
 ====================================================
 
 

docs/conf.py

@@ -18,7 +18,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["adafruit_bus_device"]
+autodoc_mock_imports = ["adafruit_bus_device", "micropython"]
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
 

examples/lsm303_accel_simpletest.py

@@ -1,4 +1,4 @@
-""" Display both accelerometer and magnetometer data once per second """
+""" Display accelerometer data once per second """
 
 import time
 import board