Skip to content

Commit 01e89a8

Browse files
authored
Merge pull request #38 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 4397b48 + 9715821 commit 01e89a8

File tree

1 file changed

+28
-45
lines changed

1 file changed

+28
-45
lines changed

README.rst

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

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

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

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

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