Skip to content

Commit a6603dc

Browse files
authored
Merge pull request #35 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 64231e2 + 0b5e9c9 commit a6603dc

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-ccs811/>`_. To install for current user:
36+
37+
.. code-block:: shell
38+
39+
pip3 install adafruit-circuitpython-ccs811
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-ccs811
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-ccs811
55+
3156
Usage Notes
3257
===========
3358

@@ -71,49 +96,7 @@ Contributions are welcome! Please read our `Code of Conduct
7196
<https://github.com/adafruit/Adafruit_CircuitPython_CCS811/blob/master/CODE_OF_CONDUCT.md>`_
7297
before contributing to help this project stay welcoming.
7398

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

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