From 1e088f5d57fa388d8ed74165ff215e3efbf4db85 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Wed, 23 Oct 2019 08:52:18 -0400 Subject: [PATCH 1/3] Replaced building locally section with documentation section --- README.rst | 49 +++---------------------------------------------- 1 file changed, 3 insertions(+), 46 deletions(-) diff --git a/README.rst b/README.rst index f9a6076..21eda74 100644 --- a/README.rst +++ b/README.rst @@ -44,50 +44,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-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-busdevice --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 - -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. +Documentation +============= +For information on building library documentation, please check out `this guide `_. From 634563bb4fa1141cbc31498a508189f31ebcc7f5 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 24 Oct 2019 09:53:56 -0400 Subject: [PATCH 2/3] Added pypi, removed installing section --- README.rst | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 21eda74..ba1a4ec 100644 --- a/README.rst +++ b/README.rst @@ -20,18 +20,26 @@ changes such as mode. For I2C, it manages the device address. .. _bus_device_installation: -Installation -------------- - -This library is **NOT** built into CircuitPython to make it easy to update. To -install it either follow the directions below or `install the library -bundle `_. - -To install: - -#. Download and unzip the `latest release zip `_. -#. Copy the unzipped ``adafruit_bus_device`` to the ``lib`` directory on the ``CIRCUITPY`` drive. - +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-busdevice + +To install system-wide (this may be required in some cases): +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-busdevice + +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-busdevice + Usage Example ============= From ebe286ef03ad138fce80c3884213743755adbe58 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 24 Oct 2019 12:38:46 -0400 Subject: [PATCH 3/3] Fixed newlines --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index ba1a4ec..551efe8 100644 --- a/README.rst +++ b/README.rst @@ -28,11 +28,13 @@ PyPI `_. To install pip3 install adafruit-circuitpython-busdevice To install system-wide (this may be required in some cases): + .. code-block:: shell sudo pip3 install adafruit-circuitpython-busdevice To install in a virtual environment in your current project: + .. code-block:: shell mkdir project-name && cd project-name