Skip to content

Commit b88c893

Browse files
authored
Merge pull request #26 from adafruit/dherrada-patch-1
Added PyPi installation instructions & documentation section
2 parents 558e53e + 097531b commit b88c893

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
@@ -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-dht/>`_. To install for current user:
35+
36+
.. code-block:: shell
37+
38+
pip3 install adafruit-circuitpython-dht
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-dht
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-dht
54+
3055
Usage Example
3156
==============
3257

@@ -84,50 +109,7 @@ Contributions are welcome! Please read our `Code of Conduct
84109
<https://github.com/adafruit/Adafruit_CircuitPython_DHT/blob/master/CODE_OF_CONDUCT.md>`_
85110
before contributing to help this project stay welcoming.
86111

87-
Building locally
88-
================
89-
90-
To build this library locally you'll need to install the
91-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
92-
93-
.. code-block:: shell
94-
95-
python3 -m venv .env
96-
source .env/bin/activate
97-
pip install circuitpython-build-tools
98-
99-
Once installed, make sure you are in the virtual environment:
100-
101-
.. code-block:: shell
102-
103-
source .env/bin/activate
104-
105-
Then run the build:
106-
107-
.. code-block:: shell
108-
109-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-veml6070 --library_location .
110-
111-
Sphinx documentation
112-
-----------------------
113-
114-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
115-
install dependencies (feel free to reuse the virtual environment from above):
116-
117-
.. code-block:: shell
118-
119-
python3 -m venv .env
120-
source .env/bin/activate
121-
pip install Sphinx sphinx-rtd-theme
122-
123-
Now, once you have the virtual environment activated:
124-
125-
.. code-block:: shell
126-
127-
cd docs
128-
sphinx-build -E -W -b html . _build/html
129-
130-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
131-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
132-
locally verify it will pass.
112+
Documentation
113+
=============
133114

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