From 8b0cb14669b1884d9b5a5635eba1d03e8e174895 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 19:52:17 -0400 Subject: [PATCH 1/3] 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 b80335c..ddcabe0 100644 --- a/README.rst +++ b/README.rst @@ -40,49 +40,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-simpleio --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 53c85f8f236e9f9c5a6ba676f8d92bf21f26eb94 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 10:58:42 -0400 Subject: [PATCH 2/3] Added pypi installation instructions --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index ddcabe0..8fe2ce8 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,26 @@ 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-simpleio +To install system-wide (this may be required in some cases): + +.. code-block:: shell + sudo pip3 install adafruit-circuitpython-simpleio +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-simpleio + Usage Example ============= From a09c89f7df66c264a188bb7117bd4d2502cdd250 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 20:15:54 -0400 Subject: [PATCH 3/3] Fixed spacing --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 8fe2ce8..7b76abc 100644 --- a/README.rst +++ b/README.rst @@ -35,14 +35,19 @@ On supported GNU/Linux systems like the Raspberry Pi, you can install the driver PyPI `_. To install for current user: .. code-block:: shell + pip3 install adafruit-circuitpython-simpleio + To install system-wide (this may be required in some cases): .. code-block:: shell + sudo pip3 install adafruit-circuitpython-simpleio + 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