Skip to content

Commit f992484

Browse files
authored
Merge pull request #6 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 89fc11e + ce136b5 commit f992484

File tree

1 file changed

+22
-42
lines changed

1 file changed

+22
-42
lines changed

README.rst

Lines changed: 22 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -26,63 +26,43 @@ 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-
Usage Example
30-
=============
31-
32-
33-
Contributing
34-
============
35-
36-
Contributions are welcome! Please read our `Code of Conduct
37-
<https://github.com/adafruit/Adafruit_CircuitPython_TMP007/blob/master/CODE_OF_CONDUCT.md>`_
38-
before contributing to help this project stay welcoming.
39-
40-
Building locally
41-
================
42-
43-
Zip release files
44-
-----------------
29+
Installing from PyPI
30+
====================
4531

46-
To build this library locally you'll need to install the
47-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
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-tmp007/>`_. To install for current user:
4834

4935
.. code-block:: shell
5036
51-
python3 -m venv .env
52-
source .env/bin/activate
53-
pip install circuitpython-build-tools
37+
pip3 install adafruit-circuitpython-tmp007
5438
55-
Once installed, make sure you are in the virtual environment:
39+
To install system-wide (this may be required in some cases):
5640

5741
.. code-block:: shell
5842
59-
source .env/bin/activate
43+
sudo pip3 install adafruit-circuitpython-tmp007
6044
61-
Then run the build:
62-
63-
.. code-block:: shell
64-
65-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tmp007 --library_location .
66-
67-
Sphinx documentation
68-
-----------------------
69-
70-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
71-
install dependencies (feel free to reuse the virtual environment from above):
45+
To install in a virtual environment in your current project:
7246

7347
.. code-block:: shell
7448
49+
mkdir project-name && cd project-name
7550
python3 -m venv .env
7651
source .env/bin/activate
77-
pip install Sphinx sphinx-rtd-theme
52+
pip3 install adafruit-circuitpython-tmp007
7853
79-
Now, once you have the virtual environment activated:
54+
Usage Example
55+
=============
8056

81-
.. code-block:: shell
8257

83-
cd docs
84-
sphinx-build -E -W -b html . _build/html
58+
Contributing
59+
============
60+
61+
Contributions are welcome! Please read our `Code of Conduct
62+
<https://github.com/adafruit/Adafruit_CircuitPython_TMP007/blob/master/CODE_OF_CONDUCT.md>`_
63+
before contributing to help this project stay welcoming.
64+
65+
Documentation
66+
=============
8567

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