From 6841441c91fdbd9065db2a4dae0067ecef52d17f Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 19:30:46 -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 5d58b31..f0484a9 100644 --- a/README.rst +++ b/README.rst @@ -64,49 +64,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-pca9685 --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 e6cb611f3b293fe84f3f833a33c8fab0be8469f8 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Fri, 18 Oct 2019 10:18:16 -0400 Subject: [PATCH 2/2] Added PyPi installation instructions --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f0484a9..fd17ced 100644 --- a/README.rst +++ b/README.rst @@ -29,7 +29,8 @@ 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: @@ -51,7 +52,7 @@ To install in a virtual environment in your current project: python3 -m venv .env source .env/bin/activate pip3 install adafruit-circuitpython-pca9685 - + Usage Example =============