Skip to content

Commit e21f8aa

Browse files
committed
updated README; used information from the associated learn guide
1 parent 4707a9d commit e21f8aa

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.rst

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Introduction
1414
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_FancyLED
1515
:alt: Build Status
1616

17-
TODO
17+
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.
1818

1919
Dependencies
2020
=============
@@ -29,15 +29,7 @@ This is easily achieved by downloading
2929
Usage Example
3030
=============
3131

32-
TODO
33-
34-
API Reference
35-
=============
36-
37-
.. toctree::
38-
:maxdepth: 2
39-
40-
api
32+
See the examples in the examples/ folder.
4133

4234
Contributing
4335
============
@@ -69,3 +61,26 @@ Then run the build:
6961
.. code-block:: shell
7062
7163
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fancyled --library_location .
64+
65+
Sphinx documentation
66+
-----------------------
67+
68+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
69+
install dependencies (feel free to reuse the virtual environment from above):
70+
71+
.. code-block:: shell
72+
73+
python3 -m venv .env
74+
source .env/bin/activate
75+
pip install Sphinx sphinx-rtd-theme
76+
77+
Now, once you have the virtual environment activated:
78+
79+
.. code-block:: shell
80+
81+
cd docs
82+
sphinx-build -E -W -b html . _build/html
83+
84+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
85+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
86+
locally verify it will pass.

0 commit comments

Comments
 (0)