Skip to content

Commit 43a2b0a

Browse files
authored
Merge pull request #42 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 6cf96d5 + daef790 commit 43a2b0a

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
@@ -30,6 +30,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
3030
This is easily achieved by downloading
3131
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3232

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-rgb-display/>`_. To install for current user:
38+
39+
.. code-block:: shell
40+
41+
pip3 install adafruit-circuitpython-rgb-display
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-rgb-display
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-rgb-display
57+
3358
Usage Example
3459
=============
3560

@@ -74,49 +99,7 @@ Contributions are welcome! Please read our `Code of Conduct
7499
<https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display/blob/master/CODE_OF_CONDUCT.md>`_
75100
before contributing to help this project stay welcoming.
76101

77-
Building locally
78-
================
79-
80-
To build this library locally you'll need to install the
81-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
82-
83-
.. code-block:: shell
84-
85-
python3 -m venv .env
86-
source .env/bin/activate
87-
pip install circuitpython-build-tools
88-
89-
Once installed, make sure you are in the virtual environment:
90-
91-
.. code-block:: shell
92-
93-
source .env/bin/activate
94-
95-
Then run the build:
96-
97-
.. code-block:: shell
98-
99-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rgb_display --library_location .
100-
101-
Sphinx documentation
102-
-----------------------
103-
104-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
105-
install dependencies (feel free to reuse the virtual environment from above):
106-
107-
.. code-block:: shell
108-
109-
python3 -m venv .env
110-
source .env/bin/activate
111-
pip install Sphinx sphinx-rtd-theme
112-
113-
Now, once you have the virtual environment activated:
114-
115-
.. code-block:: shell
116-
117-
cd docs
118-
sphinx-build -E -W -b html . _build/html
102+
Documentation
103+
=============
119104

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