Skip to content

Commit 022a856

Browse files
authored
Merge pull request adafruit#28 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 8b7611a + a6573fd commit 022a856

File tree

1 file changed

+28
-45
lines changed

1 file changed

+28
-45
lines changed

README.rst

+28-45
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
3232
This is easily achieved by downloading
3333
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3434

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

@@ -69,49 +94,7 @@ Contributions are welcome! Please read our `Code of Conduct
6994
<https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/blob/master/CODE_OF_CONDUCT.md>`_
7095
before contributing to help this project stay welcoming.
7196

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

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