Skip to content

Commit 1a29646

Browse files
authored
Merge pull request #22 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents f4608f0 + 9bbb22d commit 1a29646

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

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

@@ -95,49 +120,7 @@ Contributions are welcome! Please read our `Code of Conduct
95120
<https://github.com/adafruit/Adafruit_CircuitPython_max7219/blob/master/CODE_OF_CONDUCT.md>`_
96121
before contributing to help this project stay welcoming.
97122

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

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