From 33504e2e8cb415cf2700bb95de8056ed1b303f06 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 19:15:35 -0400 Subject: [PATCH 1/3] Removed building locally section from README, replaced with documentation section --- README.rst | 51 +++------------------------------------------------ 1 file changed, 3 insertions(+), 48 deletions(-) diff --git a/README.rst b/README.rst index 0605a32..873d639 100644 --- a/README.rst +++ b/README.rst @@ -40,52 +40,7 @@ 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-mlx90614 --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 01e4bc0c5aa90ca8e21b7f2c0c1642feeac97b74 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Fri, 18 Oct 2019 21:55:42 -0400 Subject: [PATCH 2/3] Added PyPi installation instructions --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index 873d639..1385dd4 100644 --- a/README.rst +++ b/README.rst @@ -33,6 +33,31 @@ Usage Example See examples/mlx90614_simpletest.py for a demo of the usage. +nstalling 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-mlx90614 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-mlx90614 + +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-mlx90614 + Contributing ============ From e3e3caec1d4881d700820a4d2cb90a88c62e640f Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 10:51:06 -0400 Subject: [PATCH 3/3] Corrected and moved installing from pypi --- README.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 1385dd4..74d2bcc 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,6 @@ Introduction CircuitPython module for the Melexis MLX90614 Contact-less Infrared Temperature sensor. See examples/mlx90614_simpletest.py for a demo of the usage. - Dependencies ============= This driver depends on: @@ -28,12 +27,7 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. -Usage Example -============= - -See examples/mlx90614_simpletest.py for a demo of the usage. - -nstalling from PyPI +Installing from PyPI ==================== On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from @@ -58,6 +52,11 @@ To install in a virtual environment in your current project: source .env/bin/activate pip3 install adafruit-circuitpython-mlx90614 +Usage Example +============= + +See examples/mlx90614_simpletest.py for a demo of the usage. + Contributing ============