From b79d4c59adb31e2c116e806bbb3bd16626ea68f2 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 19:52:23 -0400 Subject: [PATCH 1/4] 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 37fbd1d..4d237b7 100644 --- a/README.rst +++ b/README.rst @@ -48,52 +48,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-slideshow --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 8654dfe8c80596f28bc4ce1624ebc5117191e1ba Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 10:58:33 -0400 Subject: [PATCH 2/4] Added pypi installation instructions --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index 4d237b7..72524e1 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,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-slideshow +To install system-wide (this may be required in some cases): + +.. code-block:: shell + sudo pip3 install adafruit-circuitpython-slideshow +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-slideshow + Usage Example ============= From 796c1b2cfc822728b23009dea6512346d2d5c52f Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 20:12:34 -0400 Subject: [PATCH 3/4] Fixed spacing issue --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index 72524e1..a74d231 100644 --- a/README.rst +++ b/README.rst @@ -32,7 +32,9 @@ 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-slideshow + To install system-wide (this may be required in some cases): .. code-block:: shell From 8d427b75bc2334fc3676e8772beb6f927f78c6b3 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 20:15:47 -0400 Subject: [PATCH 4/4] Fixed spacing --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index a74d231..fb350fe 100644 --- a/README.rst +++ b/README.rst @@ -38,10 +38,13 @@ PyPI `_. To install To install system-wide (this may be required in some cases): .. code-block:: shell + sudo pip3 install adafruit-circuitpython-slideshow + 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