diff --git a/readthedocs.yml b/.readthedocs.yml similarity index 100% rename from readthedocs.yml rename to .readthedocs.yml diff --git a/.travis.yml b/.travis.yml index f9390c4..d180ad0 100644 --- a/.travis.yml +++ b/.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_irremote.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-irremote --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html \ No newline at end of file diff --git a/README.rst b/README.rst index 6a1a61d..44979a8 100644 --- a/README.rst +++ b/README.rst @@ -6,11 +6,17 @@ Introduction :target: https://circuitpython.readthedocs.io/projects/irremote/en/latest/ :alt: Documentation Status -.. image :: https://badges.gitter.im/adafruit/circuitpython.svg - :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge - :alt: Gitter +.. image :: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord -TODO +CircuitPython driver for use with IR Receivers. + +Examples of products to use this library with: + +* `Circuit Playground Express `_ + +* `IR Receiver Sensor `_ Dependencies ============= @@ -25,7 +31,20 @@ This is easily achieved by downloading Usage Example ============= -TODO +.. code-block:: python + + # Circuit Playground Express Demo Code + # Adjust the pulseio 'board.PIN' if using something else + import pulseio + import board + import adafruit_irremote + + with pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True) as p: + d = adafruit_irremote.GenericDecode() + code = bytearray(4) + while True: + d.decode(p, code) + print(code) Contributing ============ @@ -34,10 +53,49 @@ Contributions are welcome! Please read our `Code of Conduct `_ 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 `_ 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-irremote --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. diff --git a/adafruit_irremote.py b/adafruit_irremote.py index 908aeb3..bfdd30a 100644 --- a/adafruit_irremote.py +++ b/adafruit_irremote.py @@ -23,7 +23,7 @@ `adafruit_irremote` ==================================================== -Demo code for upcoming CircuitPlayground Express: +Demo code for Circuit Playground Express: .. code-block: python @@ -39,6 +39,21 @@ print(code) * Author(s): Scott Shawcroft + +Implementation Notes +-------------------- + +**Hardware:** + +* `CircuitPlayground Express `_ + +* `IR Receiver Sensor `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards: + https://github.com/adafruit/circuitpython/releases + """ # Pretend self matter because we may add object level config later. diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/api.rst b/docs/api.rst similarity index 100% rename from api.rst rename to docs/api.rst diff --git a/conf.py b/docs/conf.py similarity index 90% rename from conf.py rename to docs/conf.py index 98b7234..0774943 100644 --- a/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 ------------------------------------------------ @@ -23,7 +23,7 @@ source_suffix = '.rst' # The master toctree document. -master_doc = 'README' +master_doc = 'index' # General information about the project. project = u'Adafruit IRREMOTE Library' @@ -49,7 +49,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. @@ -66,6 +66,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 ---------------------------------------------- @@ -90,6 +93,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 = 'AdafruitIRREMOTELibrarydoc' diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..7c22cdd --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/irremote_simpletest.py + :caption: examples/irremote_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b6b6c27 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,48 @@ +.. 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 + + Circuit Playground Express + IR Receiver Sensor + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/main.py b/examples/irremote_simpletest.py similarity index 88% rename from examples/main.py rename to examples/irremote_simpletest.py index 536be44..c4d7238 100644 --- a/examples/main.py +++ b/examples/irremote_simpletest.py @@ -1,3 +1,5 @@ +# Circuit Playground Express Demo Code +# Adjust the pulseio 'board.PIN' if using something else import pulseio import board import adafruit_irremote