Skip to content

Commit 25abbd5

Browse files
authored
Merge pull request #56 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents b94f06d + 853de6c commit 25abbd5

File tree

1 file changed

+28
-45
lines changed

1 file changed

+28
-45
lines changed

README.rst

+28-45
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
3939
This is easily achieved by downloading
4040
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
4141

42+
Installing from PyPI
43+
====================
44+
45+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
46+
PyPI <https://pypi.org/project/adafruit-circuitpython-neopixel/>`_. To install for current user:
47+
48+
.. code-block:: shell
49+
50+
pip3 install adafruit-circuitpython-neopixel
51+
52+
To install system-wide (this may be required in some cases):
53+
54+
.. code-block:: shell
55+
56+
sudo pip3 install adafruit-circuitpython-neopixel
57+
58+
To install in a virtual environment in your current project:
59+
60+
.. code-block:: shell
61+
62+
mkdir project-name && cd project-name
63+
python3 -m venv .env
64+
source .env/bin/activate
65+
pip3 install adafruit-circuitpython-neopixel
66+
4267
Usage Example
4368
=============
4469

@@ -89,49 +114,7 @@ Contributions are welcome! Please read our `Code of Conduct
89114
<https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/master/CODE_OF_CONDUCT.md>`_
90115
before contributing to help this project stay welcoming.
91116

92-
Building locally
93-
================
94-
95-
To build this library locally you'll need to install the
96-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
97-
98-
.. code-block:: shell
99-
100-
python3 -m venv .env
101-
source .env/bin/activate
102-
pip install circuitpython-build-tools
103-
104-
Once installed, make sure you are in the virtual environment:
105-
106-
.. code-block:: shell
107-
108-
source .env/bin/activate
109-
110-
Then run the build:
111-
112-
.. code-block:: shell
113-
114-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-neopixel --library_location .
115-
116-
Sphinx documentation
117-
-----------------------
118-
119-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
120-
install dependencies (feel free to reuse the virtual environment from above):
121-
122-
.. code-block:: shell
123-
124-
python3 -m venv .env
125-
source .env/bin/activate
126-
pip install Sphinx sphinx-rtd-theme
127-
128-
Now, once you have the virtual environment activated:
129-
130-
.. code-block:: shell
131-
132-
cd docs
133-
sphinx-build -E -W -b html . _build/html
117+
Documentation
118+
=============
134119

135-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
136-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
137-
locally verify it will pass.
120+
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

0 commit comments

Comments
 (0)