Skip to content

Commit 8532702

Browse files
committed
updated README
1 parent 25f5ec9 commit 8532702

File tree

1 file changed

+44
-5
lines changed

1 file changed

+44
-5
lines changed

README.rst

+44-5
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,49 @@ Contributions are welcome! Please read our `Code of Conduct
5656
<https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/master/CODE_OF_CONDUCT.md>`_
5757
before contributing to help this project stay welcoming.
5858

59-
API Reference
60-
=============
59+
Building locally
60+
================
61+
62+
To build this library locally you'll need to install the
63+
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
64+
65+
.. code-block:: shell
66+
67+
python3 -m venv .env
68+
source .env/bin/activate
69+
pip install circuitpython-build-tools
70+
71+
Once installed, make sure you are in the virtual environment:
72+
73+
.. code-block:: shell
74+
75+
source .env/bin/activate
76+
77+
Then run the build:
78+
79+
.. code-block:: shell
80+
81+
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-dotstar --library_location .
82+
83+
Sphinx documentation
84+
-----------------------
85+
86+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
87+
install dependencies (feel free to reuse the virtual environment from above):
88+
89+
.. code-block:: shell
90+
91+
python3 -m venv .env
92+
source .env/bin/activate
93+
pip install Sphinx sphinx-rtd-theme
94+
95+
Now, once you have the virtual environment activated:
96+
97+
.. code-block:: shell
6198
62-
.. toctree::
63-
:maxdepth: 2
99+
cd docs
100+
sphinx-build -E -W -b html . _build/html
64101
65-
api
102+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
103+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
104+
locally verify it will pass.

0 commit comments

Comments
 (0)