Skip to content

Commit

Permalink
Merge pull request #23 from adafruit/dherrada-patch-1
Browse files Browse the repository at this point in the history
Removed building locally section from README, replaced with documenta…
  • Loading branch information
kattni committed Oct 21, 2019
2 parents 9f62cd6 + 93f1bfa commit 4a5b7c8
Showing 1 changed file with 5 additions and 50 deletions.
55 changes: 5 additions & 50 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
--------------------
====================

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

Building locally
================

Zip release files
-----------------

To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.

.. code-block:: shell
python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:

.. code-block:: shell
source .env/bin/activate
Then run the build:

.. code-block:: shell
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tinylora --library_location .
Sphinx documentation
-----------------------

Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):

.. code-block:: shell
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:

.. code-block:: shell
cd docs
sphinx-build -E -W -b html . _build/html
Documentation
=============

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

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

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

0 comments on commit 4a5b7c8

Please sign in to comment.