Skip to content

Commit 4a5b7c8

Browse files
authored
Merge pull request #23 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 9f62cd6 + 93f1bfa commit 4a5b7c8

File tree

1 file changed

+5
-50
lines changed

1 file changed

+5
-50
lines changed

README.rst

Lines changed: 5 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2626
This is easily achieved by downloading `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2727

2828
Installing from PyPI
29-
--------------------
29+
====================
3030

3131
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
3232
PyPI <https://pypi.org/project/adafruit-circuitpython-tinylora/>`_. To install for current user:
@@ -64,60 +64,15 @@ Contributions are welcome! Please read our `Code of Conduct
6464
<https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa/blob/master/CODE_OF_CONDUCT.md>`_
6565
before contributing to help this project stay welcoming.
6666

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

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

11772
License
11873
=======
11974
This library was written by ClemensRiederer. We've converted it to work with Adafruit CircuitPython and made
12075
changes so it works with the Raspberry Pi and Adafruit Feather M0/M4. We've added examples for using this library
12176
to transmit data and sensor data to The Things Network.
12277

123-
This open source code is licensed under the LGPL license (see LICENSE for details).
78+
This open source code is licensed under the LGPL license (see LICENSE for details).

0 commit comments

Comments
 (0)