You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+28-48Lines changed: 28 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
30
30
This is easily achieved by downloading
31
31
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
32
32
33
+
Installing from PyPI
34
+
====================
35
+
36
+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
37
+
PyPI <https://pypi.org/project/adafruit-circuitpython-trellis/>`_. To install for current user:
38
+
39
+
.. code-block:: shell
40
+
41
+
pip3 install adafruit-circuitpython-trellis
42
+
43
+
To install system-wide (this may be required in some cases):
44
+
45
+
.. code-block:: shell
46
+
47
+
sudo pip3 install adafruit-circuitpython-trellis
48
+
49
+
To install in a virtual environment in your current project:
50
+
51
+
.. code-block:: shell
52
+
53
+
mkdir project-name &&cd project-name
54
+
python3 -m venv .env
55
+
source .env/bin/activate
56
+
pip3 install adafruit-circuitpython-trellis
57
+
33
58
Usage Example
34
59
=============
35
60
See `examples/trellis_simpletest.py <https://github.com/adafruit/Adafruit_CircuitPython_Trellis/examples/trellis_simpletest.py>`_ for full
@@ -65,52 +90,7 @@ Contributions are welcome! Please read our `Code of Conduct
Sphinx is used to build the documentation based on rST files and comments in the code. First,
99
-
install dependencies (feel free to reuse the virtual environment from above):
100
-
101
-
.. code-block:: shell
102
-
103
-
python3 -m venv .env
104
-
source .env/bin/activate
105
-
pip install Sphinx sphinx-rtd-theme
106
-
107
-
Now, once you have the virtual environment activated:
108
-
109
-
.. code-block:: shell
110
-
111
-
cd docs
112
-
sphinx-build -E -W -b html . _build/html
93
+
Documentation
94
+
=============
113
95
114
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
115
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
116
-
locally verify it will pass.
96
+
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