Skip to content

Commit 81b9434

Browse files
authored
Merge pull request #7 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents c49ae90 + a5a86ab commit 81b9434

File tree

1 file changed

+28
-48
lines changed

1 file changed

+28
-48
lines changed

README.rst

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

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

@@ -51,52 +76,7 @@ Contributions are welcome! Please read our `Code of Conduct
5176
<https://github.com/adafruit/Adafruit_CircuitPython_VEML6075/blob/master/CODE_OF_CONDUCT.md>`_
5277
before contributing to help this project stay welcoming.
5378

54-
Building locally
55-
================
56-
57-
Zip release files
58-
-----------------
59-
60-
To build this library locally you'll need to install the
61-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
62-
63-
.. code-block:: shell
64-
65-
python3 -m venv .env
66-
source .env/bin/activate
67-
pip install circuitpython-build-tools
68-
69-
Once installed, make sure you are in the virtual environment:
70-
71-
.. code-block:: shell
72-
73-
source .env/bin/activate
74-
75-
Then run the build:
76-
77-
.. code-block:: shell
78-
79-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-veml6075 --library_location .
80-
81-
Sphinx documentation
82-
-----------------------
83-
84-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
85-
install dependencies (feel free to reuse the virtual environment from above):
86-
87-
.. code-block:: shell
88-
89-
python3 -m venv .env
90-
source .env/bin/activate
91-
pip install Sphinx sphinx-rtd-theme
92-
93-
Now, once you have the virtual environment activated:
94-
95-
.. code-block:: shell
96-
97-
cd docs
98-
sphinx-build -E -W -b html . _build/html
79+
Documentation
80+
=============
9981

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