Skip to content

Commit a66f6ba

Browse files
authored
Merge pull request #1 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 2b263d6 + 129654d commit a66f6ba

File tree

1 file changed

+28
-46
lines changed

1 file changed

+28
-46
lines changed

README.rst

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

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

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

58-
Building locally
59-
================
60-
61-
To build this library locally you'll need to install the
62-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
63-
64-
.. code-block:: shell
65-
66-
python3 -m venv .env
67-
source .env/bin/activate
68-
pip install circuitpython-build-tools
69-
70-
Once installed, make sure you are in the virtual environment:
71-
72-
.. code-block:: shell
73-
74-
source .env/bin/activate
75-
76-
Then run the build:
77-
78-
.. code-block:: shell
79-
80-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lsm303dlh-mag --library_location .
81-
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
83+
Documentation
84+
=============
10185

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.
86+
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)