Skip to content

Commit 5f4189f

Browse files
authored
Merge pull request #12 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents dbceccb + 0e230d1 commit 5f4189f

File tree

1 file changed

+28
-45
lines changed

1 file changed

+28
-45
lines changed

README.rst

Lines changed: 28 additions & 45 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-sht31d/>`_. To install for current user:
36+
37+
.. code-block:: shell
38+
39+
pip3 install adafruit-circuitpython-sht31d
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-sht31d
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-sht31d
55+
3156
Usage Example
3257
=============
3358
You must import the library to use it:
@@ -102,49 +127,7 @@ Contributions are welcome! Please read our `Code of Conduct
102127
<https://github.com/adafruit/Adafruit_CircuitPython_SHT31D/blob/master/CODE_OF_CONDUCT.md>`_
103128
before contributing to help this project stay welcoming.
104129

105-
Building locally
106-
================
107-
108-
To build this library locally you'll need to install the
109-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
110-
111-
.. code-block:: shell
112-
113-
python3 -m venv .env
114-
source .env/bin/activate
115-
pip install circuitpython-build-tools
116-
117-
Once installed, make sure you are in the virtual environment:
118-
119-
.. code-block:: shell
120-
121-
source .env/bin/activate
122-
123-
Then run the build:
124-
125-
.. code-block:: shell
126-
127-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sht31d --library_location .
128-
129-
Sphinx documentation
130-
-----------------------
131-
132-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
133-
install dependencies (feel free to reuse the virtual environment from above):
134-
135-
.. code-block:: shell
136-
137-
python3 -m venv .env
138-
source .env/bin/activate
139-
pip install Sphinx sphinx-rtd-theme
140-
141-
Now, once you have the virtual environment activated:
142-
143-
.. code-block:: shell
144-
145-
cd docs
146-
sphinx-build -E -W -b html . _build/html
130+
Documentation
131+
=============
147132

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