Merge pull request #5 from brentru/improved-ref-docs

Improved ref docs

Author: kattni

readthedocs.yml renamed to .readthedocs.yml

@@ -9,6 +9,11 @@ Introduction
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
+.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_AMG88xx.svg?branch=master
+    :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_AMG88xx
+    :alt: Build Status
+
+
 Adafruit CircuitPython module for the AMG88xx GRID-Eye IR 8x8 thermal camera.
 
 Dependencies
@@ -65,13 +70,6 @@ Pixels can be then be read by doing:
 
     print(amg.pixels)
 
-API Reference
-=============
-
-.. toctree::
-   :maxdepth: 2
-
-   api
 
 Contributing
 ============

README.rst

@@ -22,7 +22,7 @@
 
 """
 `adafruit_amg88xx` - AMG88xx GRID-Eye IR 8x8 IR sensor
-====================================================
+======================================================
 This library supports the use of the AMG88xx in CircuitPython.
 
 Author(s): Dean Miller, Scott Shawcroft for Adafruit Industries.

adafruit_amg88xx.py

@@ -18,7 +18,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -54,7 +54,7 @@
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Adafruit AMG88xx Library'
@@ -89,7 +89,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.
@@ -113,6 +113,12 @@
 # The name of the Pygments (syntax highlighting) style to use.
 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
+
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 

docs/_static/favicon.ico

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

api.rst renamed to docs/api.rst

@@ -0,0 +1,46 @@
+.. 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
+
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_AMG88xx/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`