Skip to content

Commit fc35100

Browse files
authored
Merge pull request #15 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents ffdace9 + 52bb1ba commit fc35100

File tree

1 file changed

+28
-46
lines changed

1 file changed

+28
-46
lines changed

README.rst

Lines changed: 28 additions & 46 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-onewire/>`_. To install for current user:
34+
35+
.. code-block:: shell
36+
37+
pip3 install adafruit-circuitpython-onewire
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-onewire
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-onewire
53+
2954
Usage Example
3055
=============
3156

@@ -46,50 +71,7 @@ Contributions are welcome! Please read our `Code of Conduct
4671
<https://github.com/adafruit/Adafruit_CircuitPython_OneWire/blob/master/CODE_OF_CONDUCT.md>`_
4772
before contributing to help this project stay welcoming.
4873

49-
Building locally
50-
================
51-
52-
To build this library locally you'll need to install the
53-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
54-
55-
.. code-block:: shell
56-
57-
python3 -m venv .env
58-
source .env/bin/activate
59-
pip install circuitpython-build-tools
60-
61-
Once installed, make sure you are in the virtual environment:
62-
63-
.. code-block:: shell
64-
65-
source .env/bin/activate
66-
67-
Then run the build:
68-
69-
.. code-block:: shell
70-
71-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-onewire --library_location .
72-
73-
Sphinx documentation
74-
-----------------------
75-
76-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
77-
install dependencies (feel free to reuse the virtual environment from above):
78-
79-
.. code-block:: shell
80-
81-
python3 -m venv .env
82-
source .env/bin/activate
83-
pip install Sphinx sphinx-rtd-theme
84-
85-
Now, once you have the virtual environment activated:
86-
87-
.. code-block:: shell
88-
89-
cd docs
90-
sphinx-build -E -W -b html . _build/html
91-
92-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
93-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
94-
locally verify it will pass.
74+
Documentation
75+
=============
9576

77+
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)