From 638e771b1f7b20298de11bdce6c71a25f2fb360c Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 18:47:50 -0400 Subject: [PATCH 1/2] Removed building locally section from README, replaced with documentation section --- README.rst | 48 +++--------------------------------------------- 1 file changed, 3 insertions(+), 45 deletions(-) diff --git a/README.rst b/README.rst index 984b12a..b26914d 100644 --- a/README.rst +++ b/README.rst @@ -41,49 +41,7 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -Building locally -================ - -To build this library locally you'll need to install the -`circuitpython-travis-build-tools `_ package. - -.. code-block::shell - - python3 -m venv .env - source .env/bin/activate - pip install -r requirements.txt - -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-lis3dh --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 `_. From 17da755663f302b635ed0a04553ad96d56ed9e20 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Fri, 18 Oct 2019 10:17:31 -0400 Subject: [PATCH 2/2] Added PyPi installation instructions --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index b26914d..2c6c37d 100644 --- a/README.rst +++ b/README.rst @@ -34,6 +34,31 @@ 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: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-lis3dh + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-lis3dh + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-lis3dh + Contributing ============