Skip to content

Commit 1bdd89f

Browse files
authored
Merge pull request #8 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 29fd429 + a28a895 commit 1bdd89f

File tree

1 file changed

+28
-48
lines changed

1 file changed

+28
-48
lines changed

README.rst

+28-48
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2626
This is easily achieved by downloading
2727
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2828

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

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

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

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