Skip to content

Commit f49ac2e

Browse files
authored
Merge pull request #35 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 39bf016 + 43c159f commit f49ac2e

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

@@ -164,49 +189,7 @@ Contributions are welcome! Please read our `Code of Conduct
164189
<https://github.com/adafruit/Adafruit_CircuitPython_gps/blob/master/CODE_OF_CONDUCT.md>`_
165190
before contributing to help this project stay welcoming.
166191

167-
Building locally
168-
================
169-
170-
To build this library locally, you'll need to install the
171-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
172-
173-
.. code-block:: shell
174-
175-
python3 -m venv .env
176-
source .env/bin/activate
177-
pip install circuitpython-build-tools
178-
179-
Once installed, make sure you are in the virtual environment:
180-
181-
.. code-block:: shell
182-
183-
source .env/bin/activate
184-
185-
Then run the build:
186-
187-
.. code-block:: shell
188-
189-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-gps --library_location .
190-
191-
Sphinx documentation
192-
-----------------------
193-
194-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
195-
install dependencies (feel free to reuse the virtual environment from above):
196-
197-
.. code-block:: shell
198-
199-
python3 -m venv .env
200-
source .env/bin/activate
201-
pip install Sphinx sphinx-rtd-theme
202-
203-
Now, once you have the virtual environment activated:
204-
205-
.. code-block:: shell
206-
207-
cd docs
208-
sphinx-build -E -W -b html . _build/html
192+
Documentation
193+
=============
209194

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