CircuitPython classes for Adafruit FeatherWings
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_featherwing
docs
examples
.gitignore Updated requirements.txt, .travis.yml Aug 9, 2018
.pylintrc ignore the board module imports in .pylintrc Aug 25, 2018
.readthedocs.yml
.travis.yml
CODE_OF_CONDUCT.md
LICENSE Initial implementation for the Motor FeatherWing. Jan 5, 2018
README.rst
requirements.txt

README.rst

Introduction

Documentation Status Discord Build Status

This library provides FeatherWing specific classes for those that require a significant amount of initialization.

Dependencies

These drivers depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle and highly recommended over installing each one.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-featherwing --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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.