Merge pull request #3 from sommersoft/new_docs

Improve Ref Docs

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

README.rst

@@ -26,7 +26,7 @@ This is easily achieved by downloading
 Usage Example
 =============
 
-See examples/simpletest.py for a demo of the usage.
+See examples/max31865_simpletest.py for a demo of the usage.
 
 Contributing
 ============
@@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_max31865/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
-API Reference
+Building locally
-=============
+================
 
-.. toctree::
+To build this library locally you'll need to install the
-   :maxdepth: 2
+`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
 
-   api
+.. 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-max31865 --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
+
+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.

adafruit_max31865.py

@@ -27,6 +27,26 @@ CircuitPython module for the MAX31865 platinum RTD temperature sensor.  See
 examples/simpletest.py for an example of the usage.
 
 * Author(s): Tony DiCola
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* Adafruit `Universal Thermocouple Amplifier MAX31856 Breakout
+  <https://www.adafruit.com/product/3263>`_ (Product ID: 3263)
+
+* Adafruit `PT100 RTD Temperature Sensor Amplifier - MAX31865
+  <https://www.adafruit.com/product/3328>`_ (Product ID: 3328)
+
+* Adafruit `PT1000 RTD Temperature Sensor Amplifier - MAX31865
+  <https://www.adafruit.com/product/3648>`_ (Product ID: 3648)
+
+**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 math
 import time
@@ -118,7 +138,7 @@ class MAX31865:
 
     @property
     def bias(self):
-        """Get and set the boolean state of the sensor's bias (True/False)."""
+        """The state of the sensor's bias (True/False)."""
         return bool(self._read_u8(_MAX31865_CONFIG_REG) & _MAX31865_CONFIG_BIAS)
 
     @bias.setter
@@ -132,7 +152,7 @@ class MAX31865:
 
     @property
     def auto_convert(self):
-        """Get and set the boolean state of the sensor's automatic conversion
+        """The state of the sensor's automatic conversion
         mode (True/False).
         """
         return bool(self._read_u8(_MAX31865_CONFIG_REG) & _MAX31865_CONFIG_MODEAUTO)
@@ -148,15 +168,16 @@ class MAX31865:
 
     @property
     def fault(self):
-        """Get the fault state of the sensor.  Use `clear_faults` to clear the
+        """The fault state of the sensor.  Use ``clear_faults()`` to clear the
         fault state.  Returns a 6-tuple of boolean values which indicate if any
         faults are present:
-            - HIGHTHRESH
+
-            - LOWTHRESH
+        - HIGHTHRESH
-            - REFINLOW
+        - LOWTHRESH
-            - REFINHIGH
+        - REFINLOW
-            - RTDINLOW
+        - REFINHIGH
-            - OVUV
+        - RTDINLOW
+        - OVUV
         """
         faults = self._read_u8(_MAX31865_FAULTSTAT_REG)
         #pylint: disable=bad-whitespace

docs/conf.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 ------------------------------------------------
 
@@ -29,7 +29,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Adafruit MAX31865 Library'
@@ -55,7 +55,7 @@ language = None
 # 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.
@@ -72,6 +72,9 @@ pygments_style = 'sphinx'
 # 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 ----------------------------------------------
 
@@ -96,6 +99,12 @@ else:
 # 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 = 'AdafruitMAX31865Librarydoc'
 

docs/examples.rst

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

docs/index.rst

@@ -0,0 +1,51 @@
+.. 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 Universal Thermocouple Amplifier MAX31856 Breakout <https://www.adafruit.com/product/3263>
+
+    Adafruit PT100 RTD Temperature Sensor Amplifier - MAX31865  <https://www.adafruit.com/product/3328>
+
+    Adafruit PT1000 RTD Temperature Sensor Amplifier - MAX31865 <https://www.adafruit.com/product/3648>
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_MAX31865/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`