Skip to content

Commit 8195d96

Browse files
authored
Merge pull request #7 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 6d96de3 + e35b117 commit 8195d96

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-max31856/>`_. To install for current user:
34+
35+
.. code-block:: shell
36+
37+
pip3 install adafruit-circuitpython-max31856
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-max31856
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-max31856
53+
2954
Usage Example
3055
=============
3156
::
@@ -56,52 +81,7 @@ Contributions are welcome! Please read our `Code of Conduct
5681
<https://github.com/siddacious/Adafruit_CircuitPython_MAX31856/blob/master/CODE_OF_CONDUCT.md>`_
5782
before contributing to help this project stay welcoming.
5883

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

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