Skip to content

Commit bb0531a

Browse files
authored
Merge pull request #39 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents e43b1a2 + df47808 commit bb0531a

File tree

1 file changed

+28
-45
lines changed

1 file changed

+28
-45
lines changed

README.rst

+28-45
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,31 @@ Please ensure they are also available on the CircuitPython filesystem. This is
2424
easily achieved by downloading `a library and driver bundle
2525
<https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2626

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

@@ -70,49 +95,7 @@ Contributions are welcome! Please read our `Code of Conduct
7095
before contributing to help this project stay welcoming.
7196

7297

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

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