Merge pull request #3 from sommersoft/new_docs

Improve Ref Docs

Author: kattni

readthedocs.yml renamed to .readthedocs.yml

@@ -16,15 +16,18 @@ 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_tcs34725.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tcs34725 --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html
+

.travis.yml

@@ -10,6 +10,10 @@ Introduction
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
+.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TCS34725.svg?branch=master
+    :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TCS34725
+    :alt: Build Status
+
 CircuitPython module for the TCS34725 color sensor.
 
 Dependencies
@@ -26,7 +30,7 @@ This is easily achieved by downloading
 Usage Example
 =============
 
-See examples/simpletest.py for an example of the module's usage.
+See examples/tcs34725_simpletest.py for an example of the module's usage.
 
 Contributing
 ============
@@ -35,10 +39,49 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_tcs34725/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-tcs34725 --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
 
-.. toctree::
-   :maxdepth: 2
+    cd docs
+    sphinx-build -E -W -b html . _build/html
 
-   api
+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.

README.rst

@@ -25,11 +25,28 @@
 
 CircuitPython module for the TCS34725 color sensor.  Ported from the
 micropython-adafruit-tcs34725 module by Radomir Dopieralski:
-  https://github.com/adafruit/micropython-adafruit-tcs34725
+https://github.com/adafruit/micropython-adafruit-tcs34725
 
-See examples/simpletest.py for an example of the usage.
+See examples/tcs34725_simpletest.py for an example of the usage.
 
 * Author(s): Tony DiCola
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* Adafruit `RGB Color Sensor with IR filter and White LED - TCS34725
+  <https://www.adafruit.com/product/1334>`_ (Product ID: 1334)
+
+* Flora `Color Sensor with White Illumination LED - TCS34725
+  <https://www.adafruit.com/product/1356>`_ (Product ID: 1356)
+
+**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
 """
 import time
 
@@ -127,7 +144,7 @@ def _write_u16(self, address, val):
 
     @property
     def active(self):
-        """Get and set the active state of the sensor.  Boolean value that will
+        """The active state of the sensor.  Boolean value that will
         enable/activate the sensor with a value of True and disable with a
         value of False.
         """
@@ -150,7 +167,7 @@ def active(self, val):
 
     @property
     def integration_time(self):
-        """Get and set the integration time of the sensor in milliseconds."""
+        """The integration time of the sensor in milliseconds."""
         return self._integration_time
 
     @integration_time.setter
@@ -162,7 +179,7 @@ def integration_time(self, val):
 
     @property
     def gain(self):
-        """Get and set the gain of the sensor.  Should be a value of 1, 4, 16,
+        """The gain of the sensor.  Should be a value of 1, 4, 16,
         or 60.
         """
         return _GAINS[self._read_u8(_REGISTER_CONTROL)]
@@ -174,8 +191,7 @@ def gain(self, val):
 
     @property
     def interrupt(self):
-        """Get and clear the interrupt of the sensor.  Returns a bool that's
-        True if the interrupt is set.  Can be set to False (and only False)
+        """True if the interrupt is set. Can be set to False (and only False)
         to clear the interrupt.
         """
         return bool(self._read_u8(_REGISTER_STATUS) & _ENABLE_AIEN)
@@ -235,7 +251,7 @@ def lux(self):
 
     @property
     def cycles(self):
-        """Get and set the persistence cycles of the sensor."""
+        """The persistence cycles of the sensor."""
         if self._read_u8(_REGISTER_ENABLE) & _ENABLE_AIEN:
             return _CYCLES[self._read_u8(_REGISTER_APERS) & 0x0f]
         return -1
@@ -252,7 +268,7 @@ def cycles(self, val):
 
     @property
     def min_value(self):
-        """Get and set the minimum threshold value (AILT register) of the
+        """The minimum threshold value (AILT register) of the
         sensor as a 16-bit unsigned value.
         """
         return self._read_u16(_REGISTER_AILT)
@@ -263,7 +279,7 @@ def min_value(self, val):
 
     @property
     def max_value(self):
-        """Get and set the minimum threshold value (AIHT register) of the
+        """The minimum threshold value (AIHT register) of the
         sensor as a 16-bit unsigned value.
         """
         return self._read_u16(_REGISTER_AIHT)

adafruit_tcs34725.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 TCS34725 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 = 'AdafruitTCS34725Librarydoc'
 

docs/_static/favicon.ico

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

api.rst renamed to docs/api.rst

@@ -0,0 +1,49 @@
+.. 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
+
+    RGB Color Sensor with IR filter and White LED - TCS34725   <https://www.adafruit.com/product/1334>
+
+    Flora Color Sensor with White Illumination LED - TCS34725 <https://www.adafruit.com/product/1356>
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_TCS34725/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`