From a8e6a6d79697aad04d7f0b49e6a134388ae5fa44 Mon Sep 17 00:00:00 2001 From: James Carr Date: Mon, 5 Jul 2021 12:55:26 +0100 Subject: [PATCH] Update the requirements for installation and docs building --- README.rst | 8 ++++---- docs/conf.py | 2 +- requirements.txt | 2 ++ setup.py | 7 ++++++- 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 6384f2e..a4f04a1 100644 --- a/README.rst +++ b/README.rst @@ -29,17 +29,17 @@ This is easily achieved by downloading 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: +PyPI `_. To install for current user: .. code-block:: shell - pip3 install adafruit-circuitpython-display_button + pip3 install adafruit-circuitpython-display-button To install system-wide (this may be required in some cases): .. code-block:: shell - sudo pip3 install adafruit-circuitpython-display_button + sudo pip3 install adafruit-circuitpython-display-button To install in a virtual environment in your current project: @@ -48,7 +48,7 @@ To install in a virtual environment in your current project: mkdir project-name && cd project-name python3 -m venv .env source .env/bin/activate - pip3 install adafruit-circuitpython-display_button + pip3 install adafruit-circuitpython-display-button Usage Example ============= diff --git a/docs/conf.py b/docs/conf.py index 886523a..f292151 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["displayio", "adafruit_display_text", "adafruit_display_shapes"] +autodoc_mock_imports = ["displayio"] intersphinx_mapping = { diff --git a/requirements.txt b/requirements.txt index 44cdfd8..14bda77 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,5 @@ Adafruit-Blinka adafruit-blinka-displayio +adafruit-circuitpython-display-text +adafruit-circuitpython-display-shapes diff --git a/setup.py b/setup.py index 868efe4..e709c6e 100644 --- a/setup.py +++ b/setup.py @@ -33,7 +33,12 @@ # Author details author="Adafruit Industries", author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-blinka-displayio"], + install_requires=[ + "Adafruit-Blinka", + "adafruit-blinka-displayio", + "adafruit-circuitpython-display-text", + "adafruit-circuitpython-display-shapes", + ], # Choose your license license="MIT", # See https://pypi.python.org/pypi?%3Aaction=list_classifiers