Merge pull request #3 from sommersoft/new_docs

kattni · web-flow · commit 8429386bbaec · 2018-03-05T21:50:42.000-05:00
Improve Ref Docs
diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/.travis.yml b/.travis.yml
@@ -16,16 +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_fancyled/*.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fancyled --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html
diff --git a/README.rst b/README.rst
@@ -14,7 +14,7 @@ Introduction
     :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_FancyLED
     :alt: Build Status
 
-TODO
+FancyLED is a CircuitPython library to assist in creating buttery smooth LED animation. It's loosely inspired by the FastLED library for Arduino, and in fact we have a "helper" library using similar function names to assist with porting of existing Arduino FastLED projects to CircuitPython.
 
 Dependencies
 =============
@@ -29,15 +29,7 @@ This is easily achieved by downloading
 Usage Example
 =============
 
-TODO
-
-API Reference
-=============
-
-.. toctree::
-   :maxdepth: 2
-
-   api
+See the examples in the examples/ folder.
 
 Contributing
 ============
@@ -69,3 +61,26 @@ Then run the build:
 .. code-block:: shell
 
     circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fancyled --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.
diff --git a/adafruit_fancyled/adafruit_fancyled.py b/adafruit_fancyled/adafruit_fancyled.py
@@ -20,10 +20,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_fancyled`
+`adafruit_fancyled.adafruit_fancyled`
 ====================================================
 
-TODO(description)
+FancyLED is a CircuitPython library to assist in creating buttery smooth LED animation.
+It's loosely inspired by the FastLED library for Arduino, and in fact we have a "helper"
+library using similar function names to assist with porting of existing Arduino FastLED
+projects to CircuitPython.
 
 * Author(s): PaintYourDragon
 """
diff --git a/adafruit_fancyled/fastled_helpers.py b/adafruit_fancyled/fastled_helpers.py
@@ -20,10 +20,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_fancyled`
+`adafruit_fancyled.fastled_helpers`
 ====================================================
 
-TODO(description)
+CircuitPython "helper" library based on the Arduino FastLED library.
+Uses similar function names to assist with porting of existing Arduino FastLED
+projects to CircuitPython.
 
 * Author(s): PaintYourDragon
 """
@@ -54,6 +56,7 @@ def applyGamma_video(n, g_r=GFACTOR, g_g=None, g_b=None, inplace=False):
       2. A single CRGB, CHSV or packed integer type and optional gamma
          factor or separate R, G, B gamma values.
       3. A list of CRGB, CHSV or packed integer types (and optional gamma(s)).
+
       In the tuple/list cases, the 'inplace' flag determines whether
       a new tuple/list is calculated and returned, or the existing
       value is modified in-place.  By default this is 'False'.
@@ -64,6 +67,7 @@ def applyGamma_video(n, g_r=GFACTOR, g_g=None, g_b=None, inplace=False):
       1. Single gamma-corrected brightness level (0-255).
       2. A gamma-corrected CRGB value (even if input is CHSV or packed).
       3. A list of gamma-corrected CRGB values.
+
       In the tuple/list cases, there is NO return value if 'inplace'
       is true -- the original values are modified.
     """
@@ -95,6 +99,7 @@ def loadDynamicGradientPalette(src, size):
              within the overall resulting palette (whatever its size), and
              3 values for R, G and B...and a length for a new palette list
              to be allocated.
+
     RETURNS: list of CRGB colors.
     """
 
@@ -117,6 +122,7 @@ def ColorFromPalette(pal, pos, brightness=255, blend=False):
              e.g. pass 32 to retrieve palette index 2, or 40 for an
              interpolated value between palette index 2 and 3, optional
              brightness (0-255), optional blend flag (True/False)
+
     RETURNS: CRGB color, no gamma correction
     """
 
diff --git a/api.rst b/api.rst
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,8 @@
+
+.. If you created a package, create one automodule per module in the package.
+
+.. automodule:: adafruit_fancyled.adafruit_fancyled
+   :members:
+
+.. automodule:: adafruit_fancyled.fastled_helpers
+   :members:
diff --git a/docs/conf.py b/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 ------------------------------------------------
 
@@ -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 fancyled 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 = 'AdafruitFancyledLibrarydoc'
 
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,16 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/neopixel_rotate.py
+    :caption: examples/neopixel_rotate.py
+    :linenos:
+
+.. literalinclude:: ../examples/cpx_helper_example.py
+    :caption: examples/cpx_helper_example.py
+    :linenos:
+
+.. literalinclude:: ../examples/cpx_rotate.py
+    :caption: examples/cpx_rotate.py
+    :linenos:
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,45 @@
+.. 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_FancyLED/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`
