Merge pull request #3 from sommersoft/new_docs

Improve Ref Docs

Author: kattni

readthedocs.yml renamed to .readthedocs.yml

@@ -16,15 +16,17 @@ deploy:
   provider: releases
   api_key: $GITHUB_TOKEN
   file_glob: true
-  file: bundles/*
+  file: $TRAVIS_BUILD_DIR/bundles/*
   skip_cleanup: true
+  overwrite: true
   on:
     tags: true
 
 install:
-  - pip install pylint circuitpython-build-tools
+  - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
 
 script:
   - pylint adafruit_lsm9ds1.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lsm9ds1 --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html

.travis.yml

@@ -26,7 +26,7 @@ This is easily achieved by downloading
 Usage Example
 =============
 
-See examples/simpletest.py for a demo of the usage.
+See examples/lsm9ds1_simpletest.py for a demo of the usage.
 
 Contributing
 ============
@@ -35,10 +35,50 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_lsm9ds1/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
-API Reference
-=============
+Building locally
+================
+
+To build this library locally you'll need to install the
+`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install circuitpython-build-tools
+
+Once installed, make sure you are in the virtual environment:
+
+.. code-block:: shell
+
+    source .env/bin/activate
+
+Then run the build:
+
+.. code-block:: shell
+
+    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lsm9ds1 --library_location .
+
+Sphinx documentation
+-----------------------
+
+Sphinx is used to build the documentation based on rST files and comments in the code. First,
+install dependencies (feel free to reuse the virtual environment from above):
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install Sphinx sphinx-rtd-theme
+
+Now, once you have the virtual environment activated:
+
+.. code-block:: shell
+
+    cd docs
+    sphinx-build -E -W -b html . _build/html
 
-.. toctree::
-   :maxdepth: 2
+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.
 
-   api

README.rst

@@ -25,11 +25,25 @@
 
 CircuitPython module for the LSM9DS1 accelerometer, magnetometer, gyroscope.
 Based on the driver from:
-  https://github.com/adafruit/Adafruit_LSM9DS1
+https://github.com/adafruit/Adafruit_LSM9DS1
 
 See examples/simpletest.py for a demo of the usage.
 
 * Author(s): Tony DiCola
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* Adafruit `9-DOF Accel/Mag/Gyro+Temp Breakout Board - LSM9DS1
+  <https://www.adafruit.com/product/3387>`_ (Product ID: 3387)
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
+  https://github.com/adafruit/circuitpython/releases
+* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 """
 
 __version__ = "0.0.0-auto.0"
@@ -166,7 +180,7 @@ def __init__(self):
 
     @property
     def accel_range(self):
-        """Get and set the accelerometer range.  Must be a value of:
+        """The accelerometer range.  Must be a value of:
           - ACCELRANGE_2G
           - ACCELRANGE_4G
           - ACCELRANGE_8G
@@ -194,7 +208,7 @@ def accel_range(self, val):
 
     @property
     def mag_gain(self):
-        """Get and set the magnetometer gain.  Must be a value of:
+        """The magnetometer gain.  Must be a value of:
           - MAGGAIN_4GAUSS
           - MAGGAIN_8GAUSS
           - MAGGAIN_12GAUSS
@@ -222,7 +236,7 @@ def mag_gain(self, val):
 
     @property
     def gyro_scale(self):
-        """Get and set the gyroscope scale.  Must be a value of:
+        """The gyroscope scale.  Must be a value of:
           - GYROSCALE_245DPS
           - GYROSCALE_500DPS
           - GYROSCALE_2000DPS
@@ -258,7 +272,7 @@ def read_accel_raw(self):
 
     @property
     def accelerometer(self):
-        """Get the accelerometer X, Y, Z axis values as a 3-tuple of
+        """The accelerometer X, Y, Z axis values as a 3-tuple of
         m/s^2 values.
         """
         raw = self.read_accel_raw()
@@ -279,7 +293,7 @@ def read_mag_raw(self):
 
     @property
     def magnetometer(self):
-        """Get the magnetometer X, Y, Z axis values as a 3-tuple of
+        """The magnetometer X, Y, Z axis values as a 3-tuple of
         gauss values.
         """
         raw = self.read_mag_raw()
@@ -299,7 +313,7 @@ def read_gyro_raw(self):
 
     @property
     def gyroscope(self):
-        """Get the gyroscope X, Y, Z axis values as a 3-tuple of
+        """The gyroscope X, Y, Z axis values as a 3-tuple of
         degrees/second values.
         """
         raw = self.read_mag_raw()
@@ -318,7 +332,7 @@ def read_temp_raw(self):
 
     @property
     def temperature(self):
-        """Get the temperature of the sensor in degrees Celsius."""
+        """The temperature of the sensor in degrees Celsius."""
         # This is just a guess since the starting point (21C here) isn't documented :(
         # See discussion from:
         #  https://github.com/kriswiner/LSM9DS1/issues/3

adafruit_lsm9ds1.py

@@ -2,7 +2,7 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -28,7 +28,7 @@
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Adafruit LSM9DS1 Library'
@@ -54,7 +54,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -71,6 +71,9 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# If this is True, todo emits a warning for each TODO entries. The default is False.
+todo_emit_warnings = True
+
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -95,6 +98,12 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+html_favicon = '_static/favicon.ico'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'AdafruitLSM9DS1Librarydoc'
 

docs/_static/favicon.ico

@@ -0,0 +1,8 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/lsm9ds1_simpletest.py
+    :caption: examples/lsm9ds1_simpletest.py
+    :linenos:

api.rst renamed to docs/api.rst

@@ -0,0 +1,47 @@
+.. include:: ../README.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Examples
+
+    examples
+
+.. toctree::
+    :caption: API Reference
+    :maxdepth: 3
+
+    api
+
+.. toctree::
+    :caption: Tutorials
+
+.. toctree::
+    :caption: Related Products
+
+    Adafruit 9-DOF Accel/Mag/Gyro+Temp Breakout Board - LSM9DS1 <https://www.adafruit.com/product/3387>
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS1/releases/latest>
+    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
+    Discord Chat <https://adafru.it/discord>
+    Adafruit Learning System <https://learn.adafruit.com>
+    Adafruit Blog <https://blog.adafruit.com>
+    Adafruit Store <https://www.adafruit.com>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`