Skip to content

Commit 856e12d

Browse files
authored
Merge pull request #1 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 68a7310 + 0a13ecb commit 856e12d

File tree

1 file changed

+28
-46
lines changed

1 file changed

+28
-46
lines changed

README.rst

Lines changed: 28 additions & 46 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-lsm303agr_mag/>`_. To install for current user:
36+
37+
.. code-block:: shell
38+
39+
pip3 install adafruit-circuitpython-lsm303agr_mag
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-lsm303agr_mag
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-lsm303agr_mag
55+
3156
Usage Example
3257
=============
3358

@@ -56,50 +81,7 @@ Contributions are welcome! Please read our `Code of Conduct
5681
<https://github.com/adafruit/Adafruit_CircuitPython_LSM303AGR_Mag/blob/master/CODE_OF_CONDUCT.md>`_
5782
before contributing to help this project stay welcoming.
5883

59-
Building locally
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-lsm303agr-mag --library_location .
82-
83-
84-
Sphinx documentation
85-
-----------------------
86-
87-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
88-
install dependencies (feel free to reuse the virtual environment from above):
89-
90-
.. code-block:: shell
91-
92-
python3 -m venv .env
93-
source .env/bin/activate
94-
pip install Sphinx sphinx-rtd-theme
95-
96-
Now, once you have the virtual environment activated:
97-
98-
.. code-block:: shell
99-
100-
cd docs
101-
sphinx-build -E -W -b html . _build/html
84+
Documentation
85+
=============
10286

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