Skip to content

Commit e109387

Browse files
authored
Merge pull request #21 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 75be706 + 838cb14 commit e109387

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
@@ -29,6 +29,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2929
This is easily achieved by downloading
3030
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3131

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

@@ -61,49 +86,7 @@ Contributions are welcome! Please read our `Code of Conduct
6186
<https://github.com/adafruit/Adafruit_CircuitPython_MCP9808/blob/master/CODE_OF_CONDUCT.md>`_
6287
before contributing to help this project stay welcoming.
6388

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

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