Skip to content

Commit cf7eabc

Browse files
authored
Merge pull request #34 from adafruit/dherrada-patch-1
Replaced building locally section with documentation section
2 parents 1b79d17 + ebe286e commit cf7eabc

File tree

1 file changed

+21
-54
lines changed

1 file changed

+21
-54
lines changed

README.rst

+21-54
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,28 @@ changes such as mode. For I2C, it manages the device address.
2020

2121
.. _bus_device_installation:
2222

23-
Installation
24-
-------------
23+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
24+
PyPI <https://pypi.org/project/adafruit-circuitpython-busdevice/>`_. To install for current user:
2525

26-
This library is **NOT** built into CircuitPython to make it easy to update. To
27-
install it either follow the directions below or `install the library
28-
bundle <bundle_installation>`_.
26+
.. code-block:: shell
27+
28+
pip3 install adafruit-circuitpython-busdevice
29+
30+
To install system-wide (this may be required in some cases):
2931

30-
To install:
32+
.. code-block:: shell
33+
34+
sudo pip3 install adafruit-circuitpython-busdevice
35+
36+
To install in a virtual environment in your current project:
3137

32-
#. Download and unzip the `latest release zip <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/releases>`_.
33-
#. Copy the unzipped ``adafruit_bus_device`` to the ``lib`` directory on the ``CIRCUITPY`` drive.
38+
.. code-block:: shell
3439
40+
mkdir project-name && cd project-name
41+
python3 -m venv .env
42+
source .env/bin/activate
43+
pip3 install adafruit-circuitpython-busdevice
44+
3545
Usage Example
3646
=============
3747

@@ -44,50 +54,7 @@ Contributions are welcome! Please read our `Code of Conduct
4454
<https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/blob/master/CODE_OF_CONDUCT.md>`_
4555
before contributing to help this project stay welcoming.
4656

47-
Building locally
48-
================
49-
50-
To build this library locally you'll need to install the
51-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
52-
53-
.. code-block:: shell
54-
55-
python3 -m venv .env
56-
source .env/bin/activate
57-
pip install circuitpython-build-tools
58-
59-
Once installed, make sure you are in the virtual environment:
60-
61-
.. code-block:: shell
62-
63-
source .env/bin/activate
64-
65-
Then run the build:
66-
67-
.. code-block:: shell
68-
69-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-busdevice --library_location .
70-
71-
Sphinx documentation
72-
-----------------------
73-
74-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
75-
install dependencies (feel free to reuse the virtual environment from above):
76-
77-
.. code-block:: shell
78-
79-
python3 -m venv .env
80-
source .env/bin/activate
81-
pip install Sphinx sphinx-rtd-theme
82-
83-
Now, once you have the virtual environment activated:
84-
85-
.. code-block:: shell
86-
87-
cd docs
88-
sphinx-build -E -W -b html . _build/html
89-
90-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
91-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
92-
locally verify it will pass.
57+
Documentation
58+
=============
9359

60+
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)