From 71f00f0fa4675c5af9595cf5358490aec069e5cc Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 20:03:13 -0400 Subject: [PATCH 1/2] Removed building locally section from README, replaced with documentation section --- README.rst | 53 ++++------------------------------------------------- 1 file changed, 4 insertions(+), 49 deletions(-) diff --git a/README.rst b/README.rst index ccd1fd5..1e69362 100644 --- a/README.rst +++ b/README.rst @@ -64,55 +64,10 @@ Contributions are welcome! Please read our `Code of Conduct `_ 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 `_ 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 `_. License ======= @@ -120,4 +75,4 @@ This library was written by ClemensRiederer. We've converted it to work with Ada 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). \ No newline at end of file +This open source code is licensed under the LGPL license (see LICENSE for details). From 93f1bfa13a02850278e9c7bcb8e395b2abc58a70 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Fri, 18 Oct 2019 10:45:45 -0400 Subject: [PATCH 2/2] Added PyPi installation instructions --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 1e69362..bfdcd52 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. Installing from PyPI --------------------- +==================== On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI `_. To install for current user: