Skip to content

Commit 00d6b4d

Browse files
authored
Merge pull request #5 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents d05b41c + d6b9f7b commit 00d6b4d

File tree

1 file changed

+28
-48
lines changed

1 file changed

+28
-48
lines changed

README.rst

Lines changed: 28 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
3232
This is easily achieved by downloading
3333
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3434

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

@@ -54,52 +79,7 @@ Contributions are welcome! Please read our `Code of Conduct
5479
<https://github.com/adafruit/Adafruit_CircuitPython_WS2801/blob/master/CODE_OF_CONDUCT.md>`_
5580
before contributing to help this project stay welcoming.
5681

57-
Building locally
58-
================
59-
60-
Zip release files
61-
-----------------
62-
63-
To build this library locally you'll need to install the
64-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
65-
66-
.. code-block:: shell
67-
68-
python3 -m venv .env
69-
source .env/bin/activate
70-
pip install circuitpython-build-tools
71-
72-
Once installed, make sure you are in the virtual environment:
73-
74-
.. code-block:: shell
75-
76-
source .env/bin/activate
77-
78-
Then run the build:
79-
80-
.. code-block:: shell
81-
82-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ws2801 --library_location .
83-
84-
Sphinx documentation
85-
-----------------------
86-
87-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
88-
install dependencies (feel free to reuse the virtual environment from above):
89-
90-
.. code-block:: shell
91-
92-
python3 -m venv .env
93-
source .env/bin/activate
94-
pip install Sphinx sphinx-rtd-theme
95-
96-
Now, once you have the virtual environment activated:
97-
98-
.. code-block:: shell
99-
100-
cd docs
101-
sphinx-build -E -W -b html . _build/html
82+
Documentation
83+
=============
10284

103-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
104-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
105-
locally verify it will pass.
85+
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)